com.stellent.cis.client.api.scs
Interface ISCSContent

All Superinterfaces:

ICISContent, ICISObject, ICISObjectInitializable, ISCSItem, ISCSObject, java.io.Serializable

All Known Subinterfaces:

ISCSActionContent, ISCSFolder, ISCSFolderContent, ISCSInfoContent, ISCSSearchResult

public interface ISCSContent
extends ISCSItem, ICISContent

Represents a collection of metadata that identifies a particular document revision

Nested Class Summary

Nested classes/interfaces inherited from interface com.stellent.cis.client.api.common.ICISObjectInitializable

ICISObjectInitializable.AdapterVersionAware

Field Summary

Fields inherited from interface com.stellent.cis.client.api.common.ICISObject

FILTER_NULL_VALUE, FILTER_READONLY, FILTER_SYSTEM

Method Summary

java.lang.String	getComments()
java.util.Date	getExpirationDate()
java.lang.String	getExtension()
java.lang.String	getFileName()
long	getFileSize()
ISCSFolderID	getFolderID()
java.lang.String	getFormat()
ISCSInternalID	getInternalID()
java.util.Date	getReleaseDate()
java.lang.String	getRevisionLabel()
java.lang.String	getTitle()
java.util.Date	getTrashDeleteDate()
ISCSFolderID	getTrashDeleteLocation()
java.lang.String	getTrashDeleteOldName()
java.lang.String	getTrashDeleter()
java.lang.String	getWebExtension()
boolean	isHidden()
boolean	isInhibitMetaDataUpdate()
boolean	isReadOnly()
void	setComments(java.lang.String comments) Set the comments
void	setExpirationDate(java.util.Date date) Set the date the content will expire
void	setFolderID(ISCSFolderID folderID) Set the folder ID for this document
void	setFormat(java.lang.String format) Set the document format
void	setHidden(boolean hidden)
void	setInhibitMetaDataUpdate(boolean inhibitUpdate)
void	setReadOnly(boolean readOnly)
void	setReleaseDate(java.util.Date date) Set the date the document is to be released
void	setRevisionLabel(java.lang.String revisionLabel) The revision label for this item
void	setTitle(java.lang.String title) Set the document title
void	setTrashDeleteDate(java.util.Date date)
void	setTrashDeleteLocation(ISCSFolderID deletedLocation)
void	setTrashDeleteOldName(java.lang.String oldName)
void	setTrashDeleter(java.lang.String user)

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

Method Detail

getInternalID

ISCSInternalID getInternalID()

Returns:

the internal ID of the document (dDocID)

getTitle

java.lang.String getTitle()

Returns:

the document title

setTitle

void setTitle(java.lang.String title)

Set the document title

Parameters:

title - the document title

getFormat

java.lang.String getFormat()

Returns:

the format (mimetype) of the revision

setFormat

void setFormat(java.lang.String format)

Set the document format

Parameters:

format - the format (i.e. mimetype)

getReleaseDate

java.util.Date getReleaseDate()

Returns:

the date the document is to be released

setReleaseDate

void setReleaseDate(java.util.Date date)

Set the date the document is to be released

Parameters:

date - the release date

getExpirationDate

java.util.Date getExpirationDate()

Returns:

the date the document is to be expired

setExpirationDate

void setExpirationDate(java.util.Date date)

Set the date the content will expire

Parameters:

date - the expiration date

getRevisionLabel

java.lang.String getRevisionLabel()

Returns:

the document revision label

setRevisionLabel

void setRevisionLabel(java.lang.String revisionLabel)

The revision label for this item

Parameters:

revisionLabel -

getComments

java.lang.String getComments()

Returns:

get the comments, might return null

setComments

void setComments(java.lang.String comments)

Set the comments

Parameters:

comments - the comments for this document

getFolderID

ISCSFolderID getFolderID()

Returns:

get the folder ID, might return null

setFolderID

void setFolderID(ISCSFolderID folderID)

Set the folder ID for this document

Parameters:

folderID - the ID of the folder this object belongs

isInhibitMetaDataUpdate

boolean isInhibitMetaDataUpdate()

Returns:

true if the flag is set to inhibit meta-data update

setInhibitMetaDataUpdate

void setInhibitMetaDataUpdate(boolean inhibitUpdate)

Parameters:

inhibitUpdate - set to true to inhibit meta-data update

isHidden

boolean isHidden()

Returns:

true if the file is hidden

setHidden

void setHidden(boolean hidden)

Parameters:

hidden - the hidden flag

isReadOnly

boolean isReadOnly()

Returns:

true if this is read-only

setReadOnly

void setReadOnly(boolean readOnly)

Parameters:

readOnly - the read-only flag

getTrashDeleteDate

java.util.Date getTrashDeleteDate()

Returns:

the trash delete date

setTrashDeleteDate

void setTrashDeleteDate(java.util.Date date)

Parameters:

date - the trash delete date

getTrashDeleteLocation

ISCSFolderID getTrashDeleteLocation()

Returns:

folder ID of the original location of this item (if it resides in the trash)

setTrashDeleteLocation

void setTrashDeleteLocation(ISCSFolderID deletedLocation)

Parameters:

deletedLocation - the original location of this item

getTrashDeleteOldName

java.lang.String getTrashDeleteOldName()

Returns:

the original name of the object that was deleted

setTrashDeleteOldName

void setTrashDeleteOldName(java.lang.String oldName)

Parameters:

oldName - the original document name

getTrashDeleter

java.lang.String getTrashDeleter()

Returns:

name of the user that moved this item into the trash

setTrashDeleter

void setTrashDeleter(java.lang.String user)

Parameters:

user - username of the person who deleted this item

getFileName

java.lang.String getFileName()

Returns:

the original filename of the content

getFileSize

long getFileSize()

Returns:

the size of the document

getExtension

java.lang.String getExtension()

Returns:

the extension of the file name (i.e. .zip, .doc, etc.)

getWebExtension

java.lang.String getWebExtension()

Returns:

the extension of the web file name (i.e. .zip, .doc, etc.)