|
Novell exteNd Director 5.2 API |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Objects that implement this interface are entries in Directories (see EbiDirectory). Directories themselves are also Directory Entries.
EbiDirectory
Field Summary | |
static int |
OP_ADD_LEAF_NODE
The op-code for the "add entry" operation. |
Fields inherited from interface com.sssw.cm.api.EbiCmElement |
OP_COPY,
OP_MOVE,
OP_REMOVE,
OP_UPDATE |
Method Summary | |
boolean |
exists(EbiContext context)
Returns true if this Directory Entry exists. |
Collection |
getChildren(EbiContext context,
boolean checkAccess,
boolean recursive,
boolean IDsOnly)
Gets the list of children of this Directory Entry. |
EbiContentMgmtDelegate |
getContentManager()
Gets the Content Manager that manages the Repository to which this Directory Entry belongs. |
String |
getID()
Gets the ID of the Directory Entry. |
String |
getKey()
Gets the key representing this entry in the directory list. |
String |
getName()
Gets the name of the Directory Entry. |
EbiDirectory |
getParentDirectory(EbiContext context)
Returns the Directory to which this Entry belongs. |
String |
getRepositoryID()
Gets the Repository ID. |
String |
getURL(boolean encode)
Gets the URL of the Directory Entry. |
String |
getURLDontThrow(boolean encode)
Gets the URL of the Directory Entry; does not throw an exception if for one reason or another unable to retrieve the URL. |
boolean |
hasChildren()
Tells whether the Directory Entry has any child Entries. |
boolean |
hasNameChanged()
Tells whether the 'setName' method has been called on the object. |
boolean |
isChildOf(EbiContext context,
EbiDirectoryEntry dirEntry)
Returns true if the specified Directory Entry is a child of the other Directory Entry: For a Document, a Folder, a Category, or another Document may be its parent. |
boolean |
isDescendantOf(EbiContext context,
EbiDirectoryEntry dirEntry)
Checks to see whether this Directory Entry is a descendant of the specified other Directory Entry |
boolean |
isDescendantOf(EbiContext context,
EbiDirectoryEntry dirEntry,
int depth)
Checks to see whether this Directory Entry is a descendant of the specified other Directory Entry, given a certain depth value |
boolean |
isDirectory()
Determines whether the Entry is a Directory. |
boolean |
isInDefaultRepository()
Tells whether this Directory Entry belongs to the Default Repository. |
boolean |
isInSystemRepository()
Tells whether this Directory Entry belongs to the System Repository. |
boolean |
remove(EbiContext context,
boolean recursive)
Removes this Directory Entry. |
void |
removeChildren(EbiContext context,
boolean recursive)
Removes any children of this Directory Entry. |
void |
setID()
Sets/generates the UUID of the Directory Entry. |
void |
setID(String uuid)
Sets the UUID of the Directory Entry. |
void |
setLastModified(Timestamp time)
Sets the last modified time. |
void |
setName(String name)
Sets the name of this entry to a new value, effective when the update method is invoked. |
void |
setRepositoryID(String repID)
Sets the Repository ID, this method is intended for internal use only and shouldn't normally be invoked by others. |
void |
update(EbiContext context)
Saves any changes made to this Directory Entry via the setter methods, to the Repository |
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 OP_ADD_LEAF_NODE
Method Detail |
public String getID()
public String getName()
public String getURL(boolean encode) throws EboUnrecoverableSystemException, EboSecurityException
encode
- whether the returned relative URL string
should be encoded (to allow for non-7-bit-ASCII characters
in a URL)public String getURLDontThrow(boolean encode)
encode
- whether the returned relative URL string
should be encoded (to allow for non-7-bit-ASCII characters
in a URL)public boolean isDirectory()
public void setName(String name)
name
- the new name; must not contain
the '/' character due to the fact that it is used as the
separator in directory entry pathsEbiDirectoryEntry.update(EbiContext)
,
EbiContentMgmtDelegate.updateDocument(EbiContext, EbiDocument)
,
EbiContentMgmtDelegate.updateFolder(EbiContext, EbiDocFolder)
,
EbiContentMgmtDelegate.updateCategory(EbiContext, EbiDocCategory)
public String getKey()
public void setRepositoryID(String repID)
repID
- the Repository IDpublic String getRepositoryID()
public void setID()
public void setID(String uuid)
uuid
- the UUID of the Directory Entrypublic Collection getChildren(EbiContext context, boolean checkAccess, boolean recursive, boolean IDsOnly) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextcheckAccess
- whether to filter out items inaccessible by the user
whose context is passed inrecursive
- whether to recurse the hierarchyIDsOnly
- if true, return a Collection of String IDs of children,
otherwise return Java objects (CM elements).public boolean hasChildren() throws EboUnrecoverableSystemException, EboSecurityException
public boolean exists(EbiContext context) throws EboUnrecoverableSystemException, EboSecurityException
context
- contextpublic boolean isDescendantOf(EbiContext context, EbiDirectoryEntry dirEntry) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextdirEntry
- the other Directory Entry to check againstpublic boolean isDescendantOf(EbiContext context, EbiDirectoryEntry dirEntry, int depth) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextdirEntry
- the other Directory Entry to check againstdepth
- specifies how the checking is to be performed; if depth = 0,
then the check is an equality comparison, if depth = 1, then the method
checks if the Directory Entry is a child of the other Entry, if
depth = -1, then the method checks if the Directory Entry is
a descendant at any level; for any other value the method checks
whether the Directory Entry is a descendant anywhere within the 'depth'
number of levelspublic boolean isChildOf(EbiContext context, EbiDirectoryEntry dirEntry) throws EboUnrecoverableSystemException
context
- contextdirEntry
- potential parent Directory Entrypublic EbiDirectory getParentDirectory(EbiContext context) throws EboUnrecoverableSystemException, EboSecurityException
context
- contextpublic EbiContentMgmtDelegate getContentManager() throws EboUnrecoverableSystemException, EboSecurityException
public boolean isInDefaultRepository() throws EboUnrecoverableSystemException, EboSecurityException
public boolean isInSystemRepository() throws EboUnrecoverableSystemException, EboSecurityException
public boolean remove(EbiContext context, boolean recursive) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextrecursive
- if true, remove any descendants of this Directory Entry,
if false, do not attempt to remove the descendants; note that for a
Document, 'recursive' of 'false' will result in the Document being
removed and any child Documents preserved, whereas for a Directory, this
will result in an exception, if any children are foundpublic void removeChildren(EbiContext context, boolean recursive) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextrecursive
- if true, remove all of the descendants of this
Directory Entry, if false, attempt to remove only the immediate
descendants; if 'recursive' is false and any of the children happen to
be Directories that are non-empty, then an exception is thrownpublic void update(EbiContext context) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextpublic boolean hasNameChanged()
public void setLastModified(Timestamp time)
time
- the last modified time
|
Novell exteNd Director 5.2 API |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |