|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Folder
Defining a folder object which can hold various items including child folders.
Method Summary | |
---|---|
boolean |
accept(DocumentId id)
Tests the DocumentType of the given document id against this folder's one. |
boolean |
accept(Item item)
Tests the DocumentType of the given document against this folder's one. |
void |
addDocument(Document document,
boolean refreshDoc)
Add a document into this folder. |
ResultIterator<Folder> |
getChildFolders()
Obtain only child folders under this folder. |
ResultIterator<Item> |
getChildren()
Obtain items and folders under this folder. |
com.ibm.workplace.wcm.api.FolderDocumentType[] |
getDocumentTypes()
Document type of this folder. |
Item |
getParent()
Get the parent folder. |
boolean |
isEmpty()
Indicates if this folder contains any children |
boolean |
isPresetFolder()
Returns true if this folder is a preset folder |
void |
setDocumentTypes(com.ibm.workplace.wcm.api.FolderDocumentType[] types)
Set the DocumentType of this folder. |
Methods inherited from interface com.ibm.workplace.wcm.api.Item |
---|
getCreationDate, getDescription, getIdentity, getModifiedDate, getName, getTitle |
Methods inherited from interface com.ibm.portal.Localized |
---|
getLocales |
Methods inherited from interface com.ibm.workplace.wcm.api.EditableItem |
---|
setDescription, setName, setTitle |
Methods inherited from interface com.ibm.workplace.wcm.api.Hierarchical |
---|
getParentId |
Method Detail |
---|
com.ibm.workplace.wcm.api.FolderDocumentType[] getDocumentTypes()
DocumentType
can be added to this folder.
If no type is assigned yet, returns null.
void setDocumentTypes(com.ibm.workplace.wcm.api.FolderDocumentType[] types) throws com.ibm.workplace.wcm.api.exceptions.IllegalDocumentTypeException
DocumentType
of this folder.
Once set, folders can only be modified if the folder is empty, or cleared (via
a null or empty type list). If cleared, the folder will have its DocumentType
s
reset to its parent folders DocumentType
s on save
types
- folder document types for this folder
com.ibm.workplace.wcm.api.exceptions.IllegalDocumentTypeException
- if an attempt is made to alter the type (other than clear) and
the folder isn't empty.boolean accept(Item item)
DocumentType
of the given document against this folder's one.
item
- to check if acceptable
boolean accept(DocumentId id) throws com.ibm.workplace.wcm.api.exceptions.AuthorizationException, com.ibm.workplace.wcm.api.exceptions.DocumentRetrievalException
DocumentType
of the given document id against this folder's one.
id
- to check if acceptable
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
com.ibm.workplace.wcm.api.exceptions.DocumentRetrievalException
ResultIterator<Item> getChildren() throws com.ibm.workplace.wcm.api.exceptions.QueryServiceException
com.ibm.workplace.wcm.api.exceptions.QueryServiceException
ResultIterator<Folder> getChildFolders() throws com.ibm.workplace.wcm.api.exceptions.QueryServiceException
com.ibm.workplace.wcm.api.exceptions.QueryServiceException
boolean isEmpty()
boolean isPresetFolder()
Item getParent()
null
will be returned.
void addDocument(Document document, boolean refreshDoc) throws com.ibm.workplace.wcm.api.exceptions.IllegalDocumentTypeException, com.ibm.workplace.wcm.api.exceptions.AuthorizationException, com.ibm.workplace.wcm.api.exceptions.FolderException
document
- The document to add to this folder.refreshDoc
- Indicates whether to refresh the properties of the added document. If not done, the properties of the document will
not be correct.
com.ibm.workplace.wcm.api.exceptions.IllegalDocumentTypeException
- The document type is not allowed
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
- The user is not authorized
com.ibm.workplace.wcm.api.exceptions.FolderException
- An exception occurred executing the action
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |