Interface PublishableAsset
-
- All Superinterfaces:
BaseAsset
,FolderContainedAsset
,MetadataAwareAsset
,NamedAsset
,PermissionsCapableAsset
public interface PublishableAsset extends MetadataAwareAsset
Represents an asset that is able to be published.- Since:
- 4.7
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getLastPublishedBy()
java.util.Date
getLastPublishedOn()
java.lang.String
getLink()
boolean
getShouldBeIndexed()
boolean
getShouldBePublished()
Get whether or not this asset is publishable.void
setIncludeWhenIndexing(boolean index)
Set whether or not this asset is to be included when indexing.void
setIncludeWhenPublishing(boolean publish)
Set whether or not this asset is to be included when publishing.-
Methods inherited from interface com.hannonhill.cascade.api.asset.common.BaseAsset
getAssetId, getAssetType, getIdentifer
-
Methods inherited from interface com.hannonhill.cascade.api.asset.home.FolderContainedAsset
getCreatedBy, getCreatedOn, getFolderOrder, getIdentifier, getLastModified, getLastModifiedBy, getParentFolder, getParentFolderIdentifier, getPath, getSite, getSiteId, getSiteName, getTags, isHideSystemName, setHideSystemName, setParentFolder, setParentFolderIdentifier
-
Methods inherited from interface com.hannonhill.cascade.api.asset.home.MetadataAwareAsset
getLabel, getLinkingAssets, getMetadata, getMetadataSet, getMetadataSetId
-
Methods inherited from interface com.hannonhill.cascade.api.asset.common.NamedAsset
getName, setName
-
Methods inherited from interface com.hannonhill.cascade.api.asset.common.PermissionsCapableAsset
isCurrentUserCanRead, isCurrentUserCanWrite, isUserCanRead, isUserCanWrite
-
-
-
-
Method Detail
-
getShouldBePublished
boolean getShouldBePublished()
Get whether or not this asset is publishable.- Returns:
- true if this asset can be published, false otherwise.
-
setIncludeWhenPublishing
void setIncludeWhenPublishing(boolean publish)
Set whether or not this asset is to be included when publishing.- Parameters:
publish
- true to have this asset included when publishing, false for this asset never to be published.
-
getLastPublishedOn
java.util.Date getLastPublishedOn()
- Returns:
- Get the
Date
this asset was last published.
-
getLastPublishedBy
java.lang.String getLastPublishedBy()
- Returns:
- Get the name of the user who last published this asset.
-
getShouldBeIndexed
boolean getShouldBeIndexed()
- Returns:
- Returns true if the asset should be indexed inside of index blocks
-
setIncludeWhenIndexing
void setIncludeWhenIndexing(boolean index)
Set whether or not this asset is to be included when indexing.- Parameters:
index
- true to have this asset included when indexing, false for this asset never to be indexed.
-
getLink
java.lang.String getLink()
- Returns:
- Returns link in format site://SITENAME/PATH/TO/ASSET
-
-