Package com.hannonhill.cascade.api.asset.home

Interface FolderContainedAsset

All Superinterfaces:

BaseAsset, NamedAsset, PermissionsCapableAsset

All Known Subinterfaces:

Block, FeedBlock, File, Folder, Format, IndexBlock, MetadataAwareAsset, Page, PublishableAsset, Reference, ScriptFormat, Symlink, Template, TextBlock, TwitterFeedBlock, XHTMLDataDefinitionBlock, XMLBlock, XSLTFormat

public interface FolderContainedAsset
extends PermissionsCapableAsset

Describes the common properties that any asset contained within a folder shares.

Since:

4.7

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCreatedBy()	Get the name of the user who created this asset.
java.util.Date	getCreatedOn()	Get the Date this asset was created.
int	getFolderOrder()	Get the folder order of this asset.
PathIdentifier	getIdentifier()	Get this asset's identifier, which will also include the asset's path in addition to the standard information a regular Identifier contains.
java.util.Date	getLastModified()	Get the Date this asset was last modified.
java.lang.String	getLastModifiedBy()	Get the name of the user who last modified this asset.
Folder	getParentFolder()	Get a data transfer object representing the parent folder.
PathIdentifier	getParentFolderIdentifier()	Get the parent folder's identifier, which specifies the relationship between this asset and its containing folder.
java.lang.String	getPath()	Get the path of the asset
Site	getSite()
java.lang.String	getSiteId()
java.lang.String	getSiteName()
java.util.List<java.lang.String>	getTags()
boolean	isHideSystemName()
void	setHideSystemName(boolean hideSystemName)	Set to true in AssetFactoryPlugin.doPluginActionPre(com.hannonhill.cascade.api.asset.admin.AssetFactory, FolderContainedAsset) and the system name field will be hidden
void	setParentFolder(Folder parentFolder)	Set the data transfer object representing the parent folder.
void	setParentFolderIdentifier(Identifier parentFolderIdentifier)	Set the parent folder's identifier, which specifies the relationship between this asset and its containing folder.

Methods inherited from interface com.hannonhill.cascade.api.asset.common.BaseAsset

getAssetId, getAssetType, getIdentifer

Methods inherited from interface com.hannonhill.cascade.api.asset.common.NamedAsset

getLabel, getName, setName

Methods inherited from interface com.hannonhill.cascade.api.asset.common.PermissionsCapableAsset

isCurrentUserCanRead, isCurrentUserCanWrite, isUserCanRead, isUserCanWrite

Method Detail

getIdentifier

PathIdentifier getIdentifier()

Get this asset's identifier, which will also include the asset's path in addition to the standard information a regular Identifier contains.

Returns:

a PathIdentifierImpl, never null

getParentFolderIdentifier

PathIdentifier getParentFolderIdentifier()

Get the parent folder's identifier, which specifies the relationship between this asset and its containing folder.

Returns:

the Identifier of the parent folder

setParentFolderIdentifier

void setParentFolderIdentifier(Identifier parentFolderIdentifier)

Set the parent folder's identifier, which specifies the relationship between this asset and its containing folder.

Changing this will have the effect of moving an asset.

Parameters:

parentFolderIdentifier - the identifier identifying the new parent folder

getParentFolder

Folder getParentFolder()

Get a data transfer object representing the parent folder.

Returns:

a Folder object

setParentFolder

void setParentFolder(Folder parentFolder)

Set the data transfer object representing the parent folder.

Parameters:

parentFolder - the Folder object representing the folder which will be the new parent folder for this asset

getCreatedOn

java.util.Date getCreatedOn()

Get the Date this asset was created.

Returns:

getCreatedBy

java.lang.String getCreatedBy()

Get the name of the user who created this asset.

Returns:

getLastModified

java.util.Date getLastModified()

Get the Date this asset was last modified.

Returns:

getLastModifiedBy

java.lang.String getLastModifiedBy()

Get the name of the user who last modified this asset.

Returns:

getFolderOrder

int getFolderOrder()

Get the folder order of this asset.

Returns:

the folder order of this asset.

getPath

java.lang.String getPath()

Get the path of the asset

Returns:

getSiteId

java.lang.String getSiteId()

Returns:

Returns id of the site in which the asset is located

getSiteName

java.lang.String getSiteName()

Returns:

Returns name of the site in which the asset is located

getSite

Site getSite()

Returns:

Returns the Site object to retrieve additional site parameters, such as URL

setHideSystemName

void setHideSystemName(boolean hideSystemName)

Set to true in AssetFactoryPlugin.doPluginActionPre(com.hannonhill.cascade.api.asset.admin.AssetFactory, FolderContainedAsset) and the system name field will be hidden

Parameters:

hideSystemName -

isHideSystemName

boolean isHideSystemName()

Returns:

Returns the previously set (using setHideSystemName(boolean)) hideSystemName value or false if not set.

getTags

java.util.List<java.lang.String> getTags()

Returns:

Returns a list of tags assigned to the asset.