|
Novell exteNd Director 5.2 API |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Objects implementing this interface represent Directories (collections of items which are leaf nodes or other Directories).
Field Summary | |
static int |
DIR_TYPE_APP_FIRST
The first value in the set of application-specific Directory types. |
static int |
DIR_TYPE_DEFAULT
The default Directory type |
static int |
DIR_TYPE_ROOT
The "root" directory type, meaning the Directory has no parent(s). |
static int |
DIR_TYPE_SYS1
The first system-reserved Directory type bit. |
static int |
DIR_TYPE_SYS2
The second system-reserved Directory type bit. |
static int |
DIR_TYPE_SYS3
The third system-reserved Directory type bit. |
static int |
DIR_TYPE_SYS4
The fourth system-reserved Directory type bit. |
static int |
DIR_TYPE_SYS5
The fifth system-reserved Directory type bit. |
static int |
DIR_TYPE_SYSTEM
The "system" Directory type. |
static int |
OP_ADD_SUBDIR
The op-code for the "add subdirectory" operation. |
Fields inherited from interface com.sssw.cm.api.EbiDirectoryEntry |
OP_ADD_LEAF_NODE |
Fields inherited from interface com.sssw.cm.api.EbiCmElement |
OP_COPY,
OP_MOVE,
OP_REMOVE,
OP_UPDATE |
Method Summary | |
Collection |
getChildren(EbiContext context,
boolean getSubdirectories,
boolean getDocuments,
boolean recurseSubdirectories)
Lists all the child Elements of this Directory. |
Collection |
getChildren(EbiContext context,
boolean checkAccess,
boolean getSubdirectories,
boolean getDocuments,
boolean recurseSubdirectories)
Lists all the child Elements of this Directory, optionally filtering out any inaccessible items. |
int |
getCount(EbiContext context,
boolean countSubdirs,
boolean countDocs,
boolean countAccessibleOnly)
Calculates the number of entries in the directory. |
String |
getDescription()
Gets the description of this Directory. |
int |
getDirectoryType()
Gets the type of the Directory |
EbiDocument |
getDocument(EbiContext context,
String relativePath)
Given a relative path to a Document, retrieves it. |
EbiDirectoryEntry |
getEntry(EbiContext context,
String relativePath,
String elementType)
Given a relative path to a Directory Entry, retrieves it. |
String |
getParentID()
Gets the ID of the parent directory for this directory |
boolean |
isRoot()
Determines if this Directory is the root one (i.e. |
boolean |
isSystemDirectory()
Determines if the Directory is a system one. |
boolean |
isTopLevel()
Determines if the Directory is a top-level one, i.e. |
int |
publishAll(EbiContext context,
boolean recursive,
int versionID)
Publishes all the Documents contained in this Directory. |
void |
removeChildren(EbiContext context,
boolean removeSubdirectories,
boolean removeDocuments)
Removes all the child Elements of this Directory. |
boolean |
removeDocument(EbiContext context,
String relativePath)
Given a relative path to a Document, removes it. |
boolean |
removeEntry(EbiContext context,
String relativePath,
String elementType)
Given a relative path to a Directory Entry, removes it. |
void |
setDescription(String description)
Sets the description of this Directory. |
void |
setDirectoryType(int dirType)
Sets the Directory type. |
void |
setParentID(String parentID)
Assigns a new parent to the directory. |
int |
unpublishAll(EbiContext context,
boolean recursive)
Unpublishes all the Documents contained in this Directory. |
Methods implemented from interface com.sssw.cm.api.EbiDirectoryEntry |
exists,
getContentManager,
getID,
getKey,
getName,
getParentDirectory,
getRepositoryID,
getURL,
getURLDontThrow,
hasChildren,
hasNameChanged,
isChildOf,
isDescendantOf,
isDescendantOf,
isDirectory,
isInDefaultRepository,
isInSystemRepository,
remove,
removeChildren,
setID,
setID,
setLastModified,
setName,
setRepositoryID,
update |
Methods implemented from interface com.sssw.fw.api.EbiSecurableElement |
getAcl,
getObjectID,
isUserAuthorized,
removeAcl,
setAcl |
Methods implemented from interface com.sssw.cm.api.EbiCmElement |
fromXML,
toXML,
validateOperation |
Methods implemented from interface java.lang.Comparable |
compareTo |
Methods implemented from interface com.sssw.fw.api.EbiFrameworkElement |
getElementUUID,
getLastModified,
getLastModifiedBy,
isEqualTo,
isReadOnly,
resetReadOnly,
setLastModified,
setLastModifiedBy,
setReadOnly |
Field Detail |
public static final int DIR_TYPE_DEFAULT
EbiDirectory.getDirectoryType()
public static final int DIR_TYPE_SYSTEM
EbiDirectory.getDirectoryType()
public static final int DIR_TYPE_ROOT
EbiDirectory.getDirectoryType()
public static final int DIR_TYPE_SYS1
EbiDirectory.getDirectoryType()
public static final int DIR_TYPE_SYS2
EbiDirectory.getDirectoryType()
public static final int DIR_TYPE_SYS3
EbiDirectory.getDirectoryType()
public static final int DIR_TYPE_SYS4
EbiDirectory.getDirectoryType()
public static final int DIR_TYPE_SYS5
EbiDirectory.getDirectoryType()
public static final int DIR_TYPE_APP_FIRST
The Directory types are bitwise masks uniquely identifying each individual Directory type. A specific Directory may therefore combine several masks into a more complex Directory type:
// Use DIR_TYPE_APP_FIRST as the seed value and derive // other application-specific types public static final int MYAPP_DIR_TYPE1 = EbiDirectory.DIR_TYPE_APP_FIRST; public static final int MYAPP_DIR_TYPE2 = MYAPP_DIR_TYPE1 * 2; public static final int MYAPP_DIR_TYPE3 = MYAPP_DIR_TYPE2 * 2; // Create a folder whose type is a combination of two // application-specific types. int type = MYAPP_DIR_TYPE1 | MYAPP_DIR_TYPE2; EbiDocFolder myFld = contentMgr.addFolder( ctx, // context parentFolder, // parent folder "myFolder", // folder name type, // folder type "my test folder", // description null); // ACL // ... do something ... // Find the folder we are interested in myFld = contentMgr.getFolder(ctx, parentFolder, "myFolder"); // Get the folder type type = myFld.getDirectoryType(); // Now, test the individual directory type bits if ((type & MYAPP_DIR_TYPE1) > 0) System.out.println("myFolder is of type 'MYAPP_DIR_TYPE1'"); if ((type & MYAPP_DIR_TYPE2) > 0) System.out.println("myFolder is of type 'MYAPP_DIR_TYPE2'");
public static final int OP_ADD_SUBDIR
Method Detail |
public boolean isRoot()
public boolean isSystemDirectory()
public boolean isTopLevel() throws EboUnrecoverableSystemException
public int getDirectoryType()
public String getDescription()
public void setDescription(String description)
description
- the description for the Directory; an 'update' method
needs to be called for this change to take effectEbiContentMgmtDelegate.updateCategory(EbiContext, EbiDocCategory)
,
EbiContentMgmtDelegate.updateFolder(EbiContext, EbiDocFolder)
public String getParentID()
public void setParentID(String parentID)
parentID
- the parent IDEbiContentMgmtDelegate.updateCategory(EbiContext, EbiDocCategory)
,
EbiContentMgmtDelegate.updateFolder(EbiContext, EbiDocFolder)
public void setDirectoryType(int dirType)
dirType
- the Directory typepublic EbiDocument getDocument(EbiContext context, String relativePath) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextrelativePath
- a path to a Document (relative to this Directory)EbiDocument
public EbiDirectoryEntry getEntry(EbiContext context, String relativePath, String elementType) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextrelativePath
- a path to a Directory Entry (relative to this
Directory)elementType
- the type of Element to look uppublic boolean removeDocument(EbiContext context, String relativePath) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextrelativePath
- a path to a Document (relative to this Directory)public boolean removeEntry(EbiContext context, String relativePath, String elementType) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextrelativePath
- a path to a Directory Entry (relative to this
Directory)elementType
- the type of Element to removepublic void removeChildren(EbiContext context, boolean removeSubdirectories, boolean removeDocuments) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextremoveSubdirectories
- remove any SubdirectoriesremoveDocuments
- remove any Documentspublic Collection getChildren(EbiContext context, boolean getSubdirectories, boolean getDocuments, boolean recurseSubdirectories) throws EboUnrecoverableSystemException, EboSecurityException
context
- contextgetSubdirectories
- if true, include any subdirectories in the
listing, otherwise exclude themgetDocuments
- if true, include any child Documents in the listing,
otherwise exclude themrecurseSubdirectories
- if true, any Subdirectories are recursed;
if false, no recursion is donepublic Collection getChildren(EbiContext context, boolean checkAccess, boolean getSubdirectories, boolean getDocuments, boolean recurseSubdirectories) throws EboUnrecoverableSystemException, EboSecurityException
context
- contextcheckAccess
- if true, only return elements to which the user
whose context is passed in, has READ accessgetSubdirectories
- if true, include any subdirectories in the
listing, otherwise exclude themgetDocuments
- if true, include any child Documents in the listing,
otherwise exclude themrecurseSubdirectories
- if true, any Subdirectories are recursed;
if false, no recursion is donepublic int publishAll(EbiContext context, boolean recursive, int versionID) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextrecursive
- if true, recurse the Directory and publish Documents
contained in it and any of the subdirectoriesversionID
- the version ID of Documents to publish; if a particular
Document does not have a version with this ID, its content is not
published; if version ID is -1, then the latest versions of content are
published for all the Documentspublic int unpublishAll(EbiContext context, boolean recursive) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextrecursive
- if true, recurse the Directory and unpublish Documents
contained in it and any of its subdirectoriespublic int getCount(EbiContext context, boolean countSubdirs, boolean countDocs, boolean countAccessibleOnly) throws EboUnrecoverableSystemException
context
- contextcountSubdirs
- if true, all subdirectories are countedcountDocs
- if true, all docs are countedcountAccessibleOnly
- if true, only the items accessible to the
user whose context is passed in, are counted (in the out-of-the-box
implementation, this security filtering is based on whether the user has
the READ access to the items counted)
|
Novell exteNd Director 5.2 API |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |