public interface Media extends Referenceable, PackagePoolItem
IDProvider.DependentReleaseType, IDProvider.RevertType, IDProvider.UidType
HistoryProvider.RevisionProvider
Modifier and Type | Field and Description |
---|---|
static int |
FILE
Type of the media: FILE
|
static int |
PICTURE
Type of the media: PICTURE
|
static IDProvider.UidType |
UID_TYPE
Uid type, see
IDProvider.getUid() . |
BLOCKED, MODIFIED, UNMODIFIED
CHANGED, NEVER_RELEASED, RELEASED
ALL_REVISIONS, EVER_SINCE, UNTIL_NOW
Modifier and Type | Method and Description |
---|---|
File |
getFile(Language language) |
String |
getFilename()
Get the filename of the current media
|
Object |
getMediaContent(Language language)
|
String |
getName()
Deprecated.
since 4.1.10 - use
IDProvider.getUid() |
boolean |
getParseFile()
State if the media must be parsed during the generation (only
FILE ) |
Picture |
getPicture(Language language) |
String |
getStoredUrl(Language language,
Resolution resolution)
Get the stored URL for this node and the provided combination of language and resolution.
|
int |
getType()
|
IDProvider.UidType |
getUidType()
Return
UID_TYPE . |
boolean |
isLanguageDependent()
Indicates whether this media is languagedependent or not.
|
void |
save()
Saves the node and all childs, shortcut for
save(null, true) . |
void |
setFilename(String filename)
Set the filename of the current media
|
void |
setParseFile(boolean parseFile)
Set if the media must be parsed during the generation (only
FILE ) |
getReferenceName
addToPackage, getChangeState, getPackage, getPackageName, isAddable, isChangeable, isPackageItem, isSubscribedItem, removeFromPackage, setChangeState
contrastWith, getDisplayName, getId, getInRevision, getLanguageInfo, getLongID, getMeta, getMetaFormData, getParent, getReleasedBy, getReleaseRevision, getReleaseStatus, getRevision, getUid, hasMeta, hasUid, isInReleaseStore, isReleased, isReleaseSupported, moveChild, moveChild, release, release, revert, setDisplayName, setMeta, setMetaFormData, setUid
appendChild, appendChildBefore, delete, exportStoreElement, getChildCount, getChildIndex, getChildren, getChildren, getChildren, getChildren, getCreateWorkflowPermission, getDefinedPrincipalPermissions, getEditor, getElementType, getFirstChild, getIncomingReferences, getInheritedPrincipalPermissions, getLastChanged, getNextSibling, getOutgoingReferences, getPermission, getPermission, getPermission, getProject, getReferences, getStore, getTreePermission, getWorkflowPermission, getWorkflowPermissions, getWriteLock, hasIncomingReferences, hasPermissions, importStoreElement, importStoreElements, inheritWorkflowPermission, isDeleted, isExportSupported, isFolder, isImportSupported, isLocked, isLockedOnServer, isLockSupported, isPermissionSupported, isWorkflowAllowed, isWorkflowSupported, refresh, removeAllWorkflowPermissions, removeChild, removePermission, removePermission, removePermission, removeWorkflowPermission, replaceChild, save, save, setInheritWorkflowPermission, setLock, setLock, setPermission, setPermission, setPermission, setWorkflowPermission, setWorkflowPermissions, setWriteLock, toXml, toXml, toXml, update
getColor, getTask, hasTask, removeTask, setColor, setTask
compareTo
asRevisionProvider, getHistory, getHistory
static final int FILE
static final int PICTURE
static final IDProvider.UidType UID_TYPE
IDProvider.getUid()
.int getType()
@NotNull @Deprecated String getName()
IDProvider.getUid()
getName
in interface StoreElement
boolean isLanguageDependent()
true
if this media is languagedependent, false
otherwiseString getFilename()
void setFilename(String filename)
filename
- new filename of the mediaboolean getParseFile()
FILE
)true
if the file "must be parsed", false
otherwisevoid setParseFile(boolean parseFile)
FILE
)parseFile
- true
file "must be parsed", false
"must not be parsed"Object getMediaContent(Language language)
language
- language of the mediaFile
or Picture
objectgetFile(de.espirit.firstspirit.access.Language)
,
getPicture(de.espirit.firstspirit.access.Language)
void save()
StoreElement
save(null, true)
.
Use StoreElement.isLockSupported()
to check if save operation is supported.
save
in interface StoreElement
IOException
- connection problemsDuplicateReferenceNameException
- if a medium with this IDProvider.getUid()
already exists on
the serverStoreElement.save(String)
@NotNull IDProvider.UidType getUidType()
UID_TYPE
.getUidType
in interface IDProvider
IDProvider.hasUid()
@Nullable String getStoredUrl(@Nullable Language language, @Nullable Resolution resolution)
null
if no URL is (yet) stored.language
- Language to get the URL for - or null
for language independent media nodes.resolution
- Resolution to get the URL for - or null
for instances of type
FILE
.null
, if no URL is yet stored.NullPointerException
- if parameter language
is null
and this node is
language dependent
or parameter resolution
is null
and this node
is of type
PICTURE
.URLProperties.getStoredUrl(Media, Language, Resolution)
Copyright © 2015 e-Spirit AG. All Rights Reserved. Build 5.1.408