|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface Folder
The Folder interface represents an existing JCR folder.
| Field Summary | |
|---|---|
static int |
LOD_LIST_MEMBERS
level depth 1 - folder with documents and bare sub folders. Use this if you want to get the documents in a folder and the folder objects contained in the requested folder. |
static int |
LOD_LIST_MEMBERS_OF_MEMBERS
level depth 2 - folder with documents and subfolders with contents, but sub folders NOT recursively. Use this if you to have the contained folders and documents of the sub folders. |
static int |
LOD_NO_MEMBERS
level depth 0 - empty sub folder and no documents, just the bare folder object. Use this for best performance if the folder itself is required not its contained documents or subfolders. |
| Method Summary | |
|---|---|
int |
getDocumentCount()
Gets the number of documents contained in this folder. |
List<Document> |
getDocuments()
Gets the documents contained in this folder. |
int |
getFolderCount()
Gets the number of subfolders contained in this folder. |
List<Folder> |
getFolders()
Gets the subfolders contained in this folder. |
int |
getLevelOfDetail()
Gets the level of detail of information contained in the Folder
object. |
| Methods inherited from interface org.eclipse.stardust.engine.api.runtime.Resource |
|---|
getId, getPath, getRepositoryId |
| Methods inherited from interface org.eclipse.stardust.engine.api.runtime.ResourceInfo |
|---|
getDateCreated, getDateLastModified, getDescription, getName, getOwner, getProperties, getProperty, setDescription, setName, setOwner, setProperties, setProperty |
| Field Detail |
|---|
static final int LOD_NO_MEMBERS
If level of detail is set to LOD_NO_MEMBERS, the Folder
object contains neither its document nor subfolder information.
static final int LOD_LIST_MEMBERS
If level of detail is set to LOD_LIST_MEMBERS,
the Folder object contains both its document and subfolder
without their document and subfolder information
static final int LOD_LIST_MEMBERS_OF_MEMBERS
LOD_LIST_MEMBERS not the whole folder tree.
If level of detail is set to LOD_LIST_MEMBERS_OF_MEMBERS,
the Folder object contains both its document and subfolder
with their document and subfolder information
| Method Detail |
|---|
int getLevelOfDetail()
Folder
object.
LOD_NO_MEMBERS, LOD_LIST_MEMBERS
or LOD_LIST_MEMBERS_OF_MEMBERS.int getDocumentCount()
List<Document> getDocuments()
DocumentManagementService.createDocument(String, DocumentInfo) to add documents
to this folder.
int getFolderCount()
List<Folder> getFolders()
DocumentManagementService.createFolder(String, FolderInfo) to add subfolders
to this folder.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||