atg.repository.content
Interface ContentRepositoryItem

All Superinterfaces:
DisplayableItem, FolderItem, RepositoryItem
All Known Implementing Classes:
GenericSecuredMutableContentItem

public interface ContentRepositoryItem
extends RepositoryItem, FolderItem

A more specific RepositoryItem interface which adds extra required properties that are useful in manipulating and displaying documents.


Field Summary
static java.lang.String CLASS_VERSION
           
 
Method Summary
 java.io.InputStream getContentByKey(java.lang.String pKey)
          Returns an InputStream to the named content piece
 java.lang.String[] getContentKeys()
          Returns an array of available content
 long getContentLastModified(java.lang.String pKey)
          Returns the time when the content was last modified.
 long getContentLength(java.lang.String pKey)
          Returns the size in bytes of the particular rendition.
 
Methods inherited from interface atg.repository.RepositoryItem
getItemDescriptor, getPropertyValue, getRepository, getRepositoryId, isTransient
 
Methods inherited from interface atg.repository.DisplayableItem
getItemDisplayName
 
Methods inherited from interface atg.repository.content.FolderItem
getAncestorFolderIds, getAncestorFolderPaths, getItemPath
 
Methods inherited from interface atg.repository.DisplayableItem
getItemDisplayName
 

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION
See Also:
Constant Field Values
Method Detail

getContentKeys

java.lang.String[] getContentKeys()
Returns an array of available content


getContentByKey

java.io.InputStream getContentByKey(java.lang.String pKey)
                                    throws RepositoryException
Returns an InputStream to the named content piece

Throws:
RepositoryException - if there was an error fetching the content

getContentLastModified

long getContentLastModified(java.lang.String pKey)
                            throws RepositoryException
Returns the time when the content was last modified. Useful for determing when local cached content should be updated.

Throws:
RepositoryException - if there was an error determining when the content was last modified.

getContentLength

long getContentLength(java.lang.String pKey)
                      throws RepositoryException
Returns the size in bytes of the particular rendition. If this value cannot be determined for this particular piece of content, -1 is returned. You can provide a null value for the key parameter to refer to the default content rendition.

Throws:
RepositoryException - if the key does not correspond to a valid key, or if there was a system error trying to access this content (such as the repository became unavailable).