|
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 represent Document Categories. Categories may contain other categories and/or documents. A Root Category is created by the system at installation time and is the top of the category hierarchy.
Field Summary | |
static String |
EL_DOC_CATEGORY
The element type of Document Category |
static String |
LIST
The 'list' permission type. |
static String |
PROTECT
The 'protect' permission type. |
static String |
READ
The 'read' permission type. |
static String |
WRITE
The 'write' permission type. |
Fields inherited from interface com.sssw.cm.api.EbiDirectory |
DIR_TYPE_APP_FIRST,
DIR_TYPE_DEFAULT,
DIR_TYPE_ROOT,
DIR_TYPE_SYS1,
DIR_TYPE_SYS2,
DIR_TYPE_SYS3,
DIR_TYPE_SYS4,
DIR_TYPE_SYS5,
DIR_TYPE_SYSTEM,
OP_ADD_SUBDIR |
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 | |
void |
addDocument(EbiContext context,
EbiDocument doc)
Assign a Document into this Category. |
EbiDocCategory |
addSubcategory(EbiContext context,
String name,
int type,
String description,
Acl acl,
boolean overwrite)
Add a subcategory to this Category. |
EbiDocCategory |
copy(EbiContext context,
EbiDocCategory destCategory,
boolean copyCategorySecurity,
boolean copySubcategories,
boolean assignDocuments,
boolean overwrite)
Copy this Category into the specified destination Category. |
EbiDocCategory |
getParentCategory(EbiContext context)
Get the parent Category. |
EbiDocCategory |
getSubcategory(EbiContext context,
String relativePath)
Get a subcategory with the specified relative path. |
EbiDocCategory |
move(EbiContext context,
EbiDocCategory destCategory,
boolean withCategorySecurity,
boolean overwrite)
Move this Category to the specified destination Category. |
boolean |
removeDocumentRef(EbiContext context,
EbiDocument doc)
Unassign the specified Document from this Category |
boolean |
removeSubcategory(EbiContext context,
String relativePath)
Remove the subcategory with the specified relative path. |
Methods implemented from interface com.sssw.cm.api.EbiDirectory |
getChildren,
getChildren,
getCount,
getDescription,
getDirectoryType,
getDocument,
getEntry,
getParentID,
isRoot,
isSystemDirectory,
isTopLevel,
publishAll,
removeChildren,
removeDocument,
removeEntry,
setDescription,
setDirectoryType,
setParentID,
unpublishAll |
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 String EL_DOC_CATEGORY
EbiElement.getType()
public static final String READ
public static final String WRITE
public static final String PROTECT
public static final String LIST
Method Detail |
public EbiDocCategory getParentCategory(EbiContext context) throws EboUnrecoverableSystemException, EboSecurityException
context
- contextpublic EbiDocCategory move(EbiContext context, EbiDocCategory destCategory, boolean withCategorySecurity, boolean overwrite) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextdestCategory
- the destination Category; note that this Category
may reside in another RepositorywithCategorySecurity
- if true, preserve security settingsoverwrite
- overwrite any entries with name collisionspublic EbiDocCategory copy(EbiContext context, EbiDocCategory destCategory, boolean copyCategorySecurity, boolean copySubcategories, boolean assignDocuments, boolean overwrite) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextdestCategory
- the destination Category; note that this Category
may reside in another RepositorycopyCategorySecurity
- if true, preserve security settings for
the Category (and any subcategories, if those are copied)copySubcategories
- if true, all the descandant subcategories are
copiedassignDocuments
- if true, documents are assigned into the copied
category; note that if the destination repository is different from the
one this Category resides in, then the Documents are copied into the
destination Repository; they are placed into Folders with the same paths
as the Folders they reside in in the source Repositorypublic void addDocument(EbiContext context, EbiDocument doc) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextdoc
- the Documentpublic EbiDocCategory addSubcategory(EbiContext context, String name, int type, String description, Acl acl, boolean overwrite) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextname
- Category nametype
- Directory type (see EbiDirectory)description
- descriptionacl
- the Acl to set; if null then the Acl of the parent Category
is inheritedoverwrite
- overwrite the existing Category with the same name, if
anypublic EbiDocCategory getSubcategory(EbiContext context, String relativePath) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextrelativePath
- the path to the subcategory, relative to this
Categorypublic boolean removeSubcategory(EbiContext context, String relativePath) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextrelativePath
- the path to the subcategory (relative to this
Category)public boolean removeDocumentRef(EbiContext context, EbiDocument doc) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextdoc
- the Document
|
Novell exteNd Director 5.2 API |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |