com.stellent.cis.client.api.scs.component.folder
Interface ISCSFolder

All Superinterfaces:
ICISContent, ICISObject, ICISObjectInitializable, ISCSContent, ISCSItem, ISCSLink, ISCSObject, java.io.Serializable

public interface ISCSFolder
extends ISCSContent, ISCSLink


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.stellent.cis.client.api.common.ICISObjectInitializable
ICISObjectInitializable.AdapterVersionAware
 
Field Summary
static int LINK_TYPE_CONTENT
           
static int LINK_TYPE_FOLDER
           
 
Fields inherited from interface com.stellent.cis.client.api.common.ICISObject
FILTER_NULL_VALUE, FILTER_READONLY, FILTER_SYSTEM
 
Method Summary
 java.lang.String getCollectionMark()
           
 java.util.Date getCreatedDate()
           
 java.lang.String getFolderName()
           
 java.lang.String getFolderOwner()
           
 ISCSFolderPathID getFolderPath()
           
 java.util.Date getLastModifiedDate()
           
 ISCSFolderID getParentID()
           
 boolean isCanDelete()
           
 boolean isEnabled()
           
 boolean isInherit()
           
 boolean isReadable()
           
 boolean isWritable()
           
 void setFolderName(java.lang.String folderName)
          Set the folder name
 void setFolderOwner(java.lang.String folderOwner)
          Set the folder owner
 void setParentID(ISCSFolderID parentID)
          Set the parent folder ID
 
Methods inherited from interface com.stellent.cis.client.api.scs.ISCSContent
getComments, getExpirationDate, getExtension, getFileName, getFileSize, getFolderID, getFormat, getInternalID, getReleaseDate, getRevisionLabel, getTitle, getTrashDeleteDate, getTrashDeleteLocation, getTrashDeleteOldName, getTrashDeleter, getWebExtension, isHidden, isInhibitMetaDataUpdate, isReadOnly, setComments, setExpirationDate, setFolderID, setFormat, setHidden, setInhibitMetaDataUpdate, setReadOnly, setReleaseDate, setRevisionLabel, setTitle, setTrashDeleteDate, setTrashDeleteLocation, setTrashDeleteOldName, setTrashDeleter
 
Methods inherited from interface com.stellent.cis.client.api.scs.ISCSItem
getAuthor, getContentID, getDocumentID, getSecurityAccount, getSecurityGroup, getType, setAuthor, setContentID, setDocumentID, setSecurityAccount, setSecurityGroup, setType
 
Methods inherited from interface com.stellent.cis.client.api.scs.ISCSObject
castObject, clearPropertyFilter, copyObject, getPropertyFilter, getSourceAdapter, getSourceObject, getSourceObjectPropertyType, mergeObject, mergeObject, removeProperty, setPropertyFilter, setRestrictedPropertyFilter, setSourceObjectPropertyType
 
Methods inherited from interface com.stellent.cis.client.api.common.ICISObject
getProperties, getPropertiesWithValue, getProperty, getPropertyAsString, getPropertyAsString, getPropertyDescriptors, hasProperty, setProperty, setProperty, setProperty
 
Methods inherited from interface com.stellent.cis.client.api.common.ICISObjectInitializable
intialize
 
Methods inherited from interface com.stellent.cis.client.api.common.ICISContent
getIdentifier, getName, getProperty, getSourceAdapter, getType, setProperty
 
Methods inherited from interface com.stellent.cis.client.api.scs.component.folder.ISCSLink
getLinkCreatedDate, getLinkFolderID, getLinkID, getLinkItemID, getLinkName, getLinkOwner, getLinkType, isLink
 

Field Detail

LINK_TYPE_CONTENT

static final int LINK_TYPE_CONTENT
See Also:
Constant Field Values

LINK_TYPE_FOLDER

static final int LINK_TYPE_FOLDER
See Also:
Constant Field Values
Method Detail

getParentID

ISCSFolderID getParentID()
Returns:
the ID of the parent folder

setParentID

void setParentID(ISCSFolderID parentID)
Set the parent folder ID

Parameters:
parentID - The ID of the parent folder

getFolderName

java.lang.String getFolderName()
Returns:
the name of the virtual folder

setFolderName

void setFolderName(java.lang.String folderName)
Set the folder name

Parameters:
folderName - The folder name

getFolderOwner

java.lang.String getFolderOwner()
Returns:
the name of the virtual folder owner

getCollectionMark

java.lang.String getCollectionMark()
Returns:
The collection mark value.

isInherit

boolean isInherit()
Returns:
Whether or not inherit is turned on.

isEnabled

boolean isEnabled()
Returns:
Whether or not this folder is enabled.

isWritable

boolean isWritable()
Returns:
Whether or not this folder is writable.

isReadable

boolean isReadable()
Returns:
Whether or not this folder is readable.

isCanDelete

boolean isCanDelete()
Returns:
Whether or not this folder can be deleted.

setFolderOwner

void setFolderOwner(java.lang.String folderOwner)
Set the folder owner

Parameters:
folderOwner -

getFolderPath

ISCSFolderPathID getFolderPath()
Returns:
the hierarchy of the folder

getCreatedDate

java.util.Date getCreatedDate()
Returns:
the date the folder was created

getLastModifiedDate

java.util.Date getLastModifiedDate()
Returns:
the date the folder was last modified