|
Novell exteNd Director 5.2 API |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Defines the notion of a Document.
A Document is comprised of the following constituents:
The mandatory pieces of metadata information on a Document are:
EbiContentManager.checkoutDocument
method is called
EbiAddDocumentParams
,
EbiContentMgmtDelegate
,
EbiDocContent
,
EbiDocCategory
,
EbiDocFolder
,
EbiDocExtnMeta
,
EbiDocLink
Field Summary | |
static int |
COMPARE_ALL
The mode for "compare all the properties of user agents": browser names, browser versions (major and minor), and platforms. |
static int |
COMPARE_MAJOR_VERS
The mask for "compare major versions". |
static int |
COMPARE_MINOR_VERS
The mask for "compare minor versions". |
static int |
COMPARE_NAMES
The mask for "compare browser names". |
static int |
COMPARE_NONE
The mode for "do not compare user agents" for the getLayout method This is useful for asking for the default layout right away. |
static int |
COMPARE_PLATFORMS
The mask for "compare platforms". |
static int |
DOC_PART_ALL
Constant that signifies that the operation is to utilize all of the document's parts |
static int |
DOC_PART_CATEGORY_REFS
Constant that signifies that the operation is to utilize the list of categories to which the given document belongs |
static int |
DOC_PART_CHILDREN
Constant that signifies that the operation is to utilize the child documents (immediate descendants) of the document |
static int |
DOC_PART_CHILDREN_RECURSIVE
Constant that signifies that the operation is to utilize the child documents as well as all of their descendants, recursively |
static int |
DOC_PART_CONTENT
Constant that signifies that the operation is to utilize the content of the document |
static int |
DOC_PART_EXTN_META
Constant that signifies that the operation is to utilize the extension metadata of the document |
static int |
DOC_PART_LAYOUT_SET
Constant that signifies that the operation is to utilize the layout set of the document |
static int |
DOC_PART_LINKS
Constant that signifies that the operation is to utilize the links for which the given document is a link-parent |
static int |
DOC_PART_META
Constant that signifies that the operation is to utilize the metadata of the document |
static int |
DOC_PART_SECURITY
Constant that signifies that the operation is to utilize the security settings on the document |
static int |
DOC_PART_VERSIONS
Constant that signifies that the operation is to utilize the versions of the document |
static int |
DOC_PUBSTATUS_NOT_PUBLISHED
Constant for the "not yet published" status for a Document. |
static int |
DOC_PUBSTATUS_PUBLISHED
Constant for the "published" status for a Document. |
static int |
DOC_PUBSTATUS_UNKNOWN
Constant for the publish status for the case when the Content Manager is unable to determine the publish status for some reason. |
static int |
DOC_PUBSTATUS_UNPUBLISHED
Constant for the "unpublished" status for a Document. |
static String |
EL_DOCUMENT
The Document element type. |
static int |
OP_RET_FAILED_HAS_CHILDREN
Return code for condition when an operation fails because the specified item has child items that belong to it |
static int |
OP_RET_FAILED_NOT_A_CHILD
Return code for condition when an operation fails because the specified item is not a child of the container on which the operation is executed. |
static int |
OP_RET_SUCCESS
Return code for successful completion of an operation. |
static String |
PROTECT
The 'protect' permission type. |
static String |
PUBLISH
The 'publish' permission type. |
static String |
READ
The 'read' permission type. |
static String |
WRITE
The 'write' permission type. |
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 | |
EbiDocument |
addChildDocument(EbiContext context,
EbiAddDocumentParams params)
Adds a child document to this document. |
int |
checkin(EbiContext context,
EbiDocContent content,
String comment,
boolean keepCheckedOut)
Checks in this Document. |
boolean |
checkout(EbiContext context)
Checks out this Document. |
EbiDocument |
copy(EbiContext context,
EbiDocFolder destFolder,
boolean overwrite,
int docParts)
Copies this document to the specified folder. |
Collection |
findSimilar(EbiContext context,
boolean checkAccess)
Finds all the documents that are similar to this one, in the Repository that this document resides. |
String |
getAbstract()
Gets the Document's abstract (summary) |
Collection |
getAllVersions(EbiContext context,
boolean getBytes)
Enumerate all the existing versions of a specific Document. |
String |
getAuthor()
Gets the name of the Document's author. |
Collection |
getCategoryReferences(EbiContext context,
boolean checkAccess,
boolean IDsOnly)
Gets the list of Categories to which this Document belongs. |
EbiDocContent |
getContent(EbiContext context,
boolean getBytes)
Gets the published content for the document, if any. |
Timestamp |
getDateCreated()
Gets the date/time of the Document's creation |
String |
getDocTypeID()
Gets the ID of the Document Type to which this Document belongs. |
String |
getDocTypeName()
Gets the name of the Document Type to which this Document belongs. |
EbiDocType |
getDocumentType(EbiContext context)
Gets the document type that this document belongs to |
String |
getEncoding()
Gets the ENCODING of published content. |
Timestamp |
getExpirationDate()
Gets the expiration date/time of the Document. |
EbiDocExtnMeta |
getExtnMeta(EbiContext context)
Gets the Extension Meta for the Document. |
EbiDocExtnMetaInfo |
getExtnMetaInfo(EbiContext context,
EbiDocField field)
Gets an Extension Meta Info for the specified Field. |
Collection |
getFieldValues(EbiContext context,
EbiDocField field)
Gets the Extension Metadata Field values for the specified Field on this Document. |
EbiDocFolder |
getFolder(EbiContext context)
Gets the folder that this Document belongs to. |
String |
getFolderID()
Gets the ID of the Folder to which this Document belongs. |
String |
getID()
Gets the ID of the Document. |
EbiDocVersion |
getLatestVersion(EbiContext context,
boolean getBytes)
Gets the latest Version of a Document whose ID is supplied. |
EbiDocVersionDescriptor |
getLayout(EbiContext context,
int mode,
boolean getDefaultIfNotFound)
Gets the Layout for this Document. |
EbiDocLayoutSet |
getLayoutSet(EbiContext context)
Gets the Layout Set for this Document. |
EbiDocLink |
getLink(EbiContext context,
EbiDocument linkDoc,
boolean isLinkParent)
Gets the specified Document Link. |
Collection |
getLinkChildren(EbiContext context,
boolean checkAccess)
Gets the list of Documents to which this Document is linked as a Link-Parent. |
Collection |
getLinkParents(EbiContext context,
boolean checkAccess)
Gets the list of Documents to which this Document is linked as a Link-Child. |
Collection |
getLinks(EbiContext context,
boolean isLinkParent)
Gets the list of Document Links that this Document is a part of. |
String |
getLockedBy()
Gets the name of the user that currently has the Document checked out. |
String |
getMimeType()
Gets the MIME type of published content. |
String |
getParentDocID()
Gets the ID of the parent Document, if any. |
EbiDocument |
getParentDocument(EbiContext context)
Gets the parent document, if any. |
Timestamp |
getPublishDate()
Gets the publish date/time of the Document. |
int |
getPublishStatus()
Gets the publish status of the Document. |
int |
getSize()
Gets the size of published content. |
String |
getStatus()
Gets the status of the Document. |
String |
getSubtitle()
Gets the subtitle of the Document |
String |
getTitle()
Gets the title of the Document |
Timestamp |
getUpdateTime()
Gets the update time (last modified) for the Document. |
EbiDocVersion |
getVersion(EbiContext context,
int versionID,
boolean getBytes)
Gets a specific Version of a Document whose ID is supplied. |
boolean |
isInCategory(EbiContext context,
EbiDocCategory category)
Checks to see if the Document belongs to the specified Category. |
EbiDocLink |
linkTo(EbiContext context,
EbiDocument linkDoc,
boolean isLinkParent,
int versionidChild,
byte[] extnMeta)
Links this Document to the specified other Document. |
EbiDocument |
move(EbiContext context,
EbiDocFolder destFolder,
boolean overwrite,
int docParts)
Moves this document to the specified folder. |
EbiDocument |
move(EbiContext context,
EbiDocument newParentDoc)
Moves this document to be the child of the new, specified parent document |
void |
orphanChildren(EbiContext context)
Removes associations of this Document with any of its Child Documents. |
void |
publishVersion(EbiContext context,
int versionID,
boolean force,
boolean overwrite)
Publishes a specific Version of this Document. |
int |
removeChildDocument(EbiContext context,
String childDocID,
boolean recursive)
Removes the child Document whose ID is specified. |
boolean |
removeLayoutSet(EbiContext context)
Removes the Layout Set for this Document. |
boolean |
removeLink(EbiContext context,
EbiDocument linkDoc,
boolean isLinkParent)
Removes the specified Link. |
void |
rollback(EbiContext context,
int rollbackVersionID,
boolean publish)
Rolls document content from the latest version back to the specified one. |
void |
setAbstract(String docAbstract)
Sets the abstract for this Document. |
void |
setAllFieldValues(EbiContext context,
EbiDocField[] fields,
Object[][] values)
Sets all the Extension Metadata Field values for this Document. |
void |
setAuthor(String author)
Sets the author of the Document. |
void |
setDateCreated(Timestamp dateCreated)
Sets the creation date/time for the Document. |
void |
setDocTypeID(String docTypeID)
Sets the Document Type ID. |
void |
setExpirationDate(Timestamp expirationDate)
Sets the expiration date/time. |
void |
setExtnMeta(EbiContext context,
EbiDocExtnMeta meta)
Sets the Extension Meta for the Document. |
void |
setExtnMetaInfo(EbiContext context,
EbiDocExtnMetaInfo emi)
Sets an Extension Meta Info for the Document. |
void |
setFieldValues(EbiContext context,
EbiDocField field,
Object[] values)
Sets Field values for the specified Field on this Document. |
void |
setFolderID(String folderID)
Sets the folder ID for this Document. |
void |
setLockedBy(String userID)
Sets the "locked by" value for the Document. |
void |
setParentDocID(String parentDocID)
Sets the ID of the parent Document. |
void |
setPublishDate(Timestamp publishDate)
Sets the publish date/time. |
void |
setPublishStatus(int status)
Sets the publish status for the Document. |
void |
setStatus(String status)
Sets the status of the Document. |
void |
setSubtitle(String subtitle)
Sets the subtitle of the Document. |
void |
setTitle(String title)
Sets the title of the Document. |
void |
setUpdateTime(Timestamp updateTime)
Sets the update time (last modified) for the Document. |
boolean |
uncheckout(EbiContext context)
Unchecks out the specified Document: releases the lock on the Document set by the user whose context is passed in. |
void |
unlinkAll(EbiContext context,
boolean isLinkParent,
boolean doCheckOuts)
Removes any links that this Document is involved in. |
boolean |
unlock(EbiContext context)
Releases or "picks" the lock set on the Document with the specified ID. |
boolean |
unpublish(EbiContext context)
Unpublishes the document, i.e. |
void |
update(EbiContext context,
boolean keepCheckedOut)
Updates the document (save all the changes that have been set so far via the setter methods). |
void |
updateLayoutSet(EbiContext context,
EbiDocLayoutSet layoutSet)
Updates the Layout Set for this Document. |
boolean |
updateLink(EbiContext context,
EbiDocLink link)
Updates the specified Link. |
Methods implemented from interface com.sssw.cm.api.EbiDirectoryEntry |
exists,
getChildren,
getContentManager,
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_DOCUMENT
public static final String READ
public static final String WRITE
public static final String PROTECT
public static final String PUBLISH
public static final int DOC_PART_ALL
public static final int DOC_PART_META
public static final int DOC_PART_CONTENT
public static final int DOC_PART_LAYOUT_SET
public static final int DOC_PART_SECURITY
public static final int DOC_PART_VERSIONS
public static final int DOC_PART_EXTN_META
public static final int DOC_PART_CHILDREN
public static final int DOC_PART_CHILDREN_RECURSIVE
public static final int DOC_PART_LINKS
public static final int DOC_PART_CATEGORY_REFS
public static final int DOC_PUBSTATUS_UNKNOWN
public static final int DOC_PUBSTATUS_NOT_PUBLISHED
public static final int DOC_PUBSTATUS_PUBLISHED
public static final int DOC_PUBSTATUS_UNPUBLISHED
public static final int COMPARE_NONE
public static final int COMPARE_ALL
public static final int COMPARE_NAMES
public static final int COMPARE_MAJOR_VERS
public static final int COMPARE_MINOR_VERS
public static final int COMPARE_PLATFORMS
public static final int OP_RET_SUCCESS
public static final int OP_RET_FAILED_NOT_A_CHILD
public static final int OP_RET_FAILED_HAS_CHILDREN
Method Detail |
public String getID()
public String getDocTypeID()
public String getDocTypeName()
public String getAuthor()
public String getTitle()
public String getSubtitle()
public String getAbstract()
public Timestamp getDateCreated()
public Timestamp getPublishDate()
public Timestamp getExpirationDate()
public String getLockedBy()
public String getStatus()
public String getParentDocID()
public String getFolderID()
public int getPublishStatus()
public Timestamp getUpdateTime()
public void setAuthor(String author)
author
- the new authorpublic void setTitle(String title)
title
- the new titlepublic void setSubtitle(String subtitle)
subtitle
- the new subtitlepublic void setAbstract(String docAbstract)
docAbstract
- the new abstractpublic void setPublishDate(Timestamp publishDate)
publishDate
- the publish date/timepublic void setExpirationDate(Timestamp expirationDate)
expirationDate
- the expiration date/timepublic void setStatus(String status)
status
- the new statuspublic void setParentDocID(String parentDocID)
parentDocID
- the new parent Document IDpublic void setFolderID(String folderID)
folderID
- the new Folder IDpublic void setDocTypeID(String docTypeID)
docTypeID
- public void setDateCreated(Timestamp dateCreated)
dateCreated
- public void setLockedBy(String userID)
checkoutDocument
method on the
Content Manager.userID
- public void setPublishStatus(int status)
status
- the publush statuspublic void setUpdateTime(Timestamp updateTime)
updateTime
- the update time (last modified) for the Documentpublic EbiDocType getDocumentType(EbiContext context) throws EboUnrecoverableSystemException, EboSecurityException
context
- the contextpublic EbiDocFolder getFolder(EbiContext context) throws EboUnrecoverableSystemException, EboSecurityException
context
- contextEbiDocFolder
public EbiDocument addChildDocument(EbiContext context, EbiAddDocumentParams params) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextparams
- parameters for the new child documentEbiAddDocumentParams
public int removeChildDocument(EbiContext context, String childDocID, boolean recursive) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextchildDocID
- the ID of the child to removerecursive
- if true, the child and all its descendants are removed,
if false, the child is only removed if it has no descendantspublic EbiDocContent getContent(EbiContext context, boolean getBytes) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextgetBytes
- whether to retrieve the actual content bytes into the
returned EbiDocContent
public int getSize()
public String getMimeType()
public String getEncoding()
public EbiDocument getParentDocument(EbiContext context) throws EboUnrecoverableSystemException, EboSecurityException
context
- public EbiDocument move(EbiContext context, EbiDocFolder destFolder, boolean overwrite, int docParts) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextdestFolder
- the destination folderoverwrite
- if true and there is a document with the same name
in the destination folder, overwrite it with the one being moved,
otherwise do nothingEbiDocFolder
public EbiDocument copy(EbiContext context, EbiDocFolder destFolder, boolean overwrite, int docParts) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextdestFolder
- the destination folderoverwrite
- if true and there is a document with the same name
in the destination folder, overwrite it with the one being copied,
otherwise do nothingdocParts
- which part of the document are to be copied (see the
DOC_PART_XXXX constants)public EbiDocument move(EbiContext context, EbiDocument newParentDoc) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextnewParentDoc
- the new parent documentpublic void update(EbiContext context, boolean keepCheckedOut) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextkeepCheckedOut
- if true, the document will still be checked out
otherwise it'll no longer be locked by the userpublic EbiDocExtnMetaInfo getExtnMetaInfo(EbiContext context, EbiDocField field) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextfield
- FieldEbiDocExtnMetaInfo
public void setExtnMetaInfo(EbiContext context, EbiDocExtnMetaInfo emi) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextemi
- the Extension Meta Info to setEbiDocExtnMetaInfo
public EbiDocExtnMeta getExtnMeta(EbiContext context) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextEbiDocExtnMeta
public void setExtnMeta(EbiContext context, EbiDocExtnMeta meta) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextmeta
- the Extension Meta for the DocumentEbiDocExtnMeta
public Collection getFieldValues(EbiContext context, EbiDocField field) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
getExtnMetaInfo
method.context
- contextfield
- the FieldEbiDocField
EbiDocField
public void setFieldValues(EbiContext context, EbiDocField field, Object[] values) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextfield
- the Field whose values are to be setvalues
- the Field valuespublic void setAllFieldValues(EbiContext context, EbiDocField[] fields, Object[][] values) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
setExtnMeta
method.context
- fields
- the list of fields to setvalues
- the Field values; each row in the matrix corresponds to
an entry in the fields
array, these are the values of that
specific FieldEbiDocField
public EbiDocLayoutSet getLayoutSet(EbiContext context) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextpublic void updateLayoutSet(EbiContext context, EbiDocLayoutSet layoutSet) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextlayoutSet
- the updated Layout Set for this Documentpublic boolean removeLayoutSet(EbiContext context) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextpublic EbiDocVersionDescriptor getLayout(EbiContext context, int mode, boolean getDefaultIfNotFound) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextmode
- the search mode specifying how to compare User Agent strings
associated with various Layout Documents against the User Agent contained
in the supplied context, see the COMPARE_*
constantsgetDefaultIfNotFound
- if true, attempt to locate the default
Document Layout in case we don't find a specific Layout that would match
the ClientEbiContentManager.getDocumentLayout(com.sssw.fw.api.EbiContext, java.lang.String, int, boolean)
,
EbiDocVersionDescriptor
public boolean checkout(EbiContext context) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextpublic int checkin(EbiContext context, EbiDocContent content, String comment, boolean keepCheckedOut) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextcontent
- the new contentcomment
- comment to go with the check-inkeepCheckedOut
- if true, the Document will continue to be checked
out to the user whose context is passed in, otherwise it'll be unlocked
and available for checkoutspublic boolean uncheckout(EbiContext context) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextpublic boolean unlock(EbiContext context) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
Security constraints:
The user whose context is passed in must have the Write access to the
Content Admin element, otherwise a security exception is thrown.
context
- contextpublic EbiDocVersion getVersion(EbiContext context, int versionID, boolean getBytes) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
Security constraints:
The user whose context is passed in must have the Read access to
the document whose ID is passed in, or the Read access to the
Content Admin element, otherwise a security exception is thrown.
context
- contextversionID
- the ID of the Version to getgetBytes
- whether to include the actual document content
into the returned EbiDocVersionpublic EbiDocVersion getLatestVersion(EbiContext context, boolean getBytes) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
Security constraints:
The user whose context is passed in must have the Read access to
the document whose ID is passed in, or the Read access to the
Content Admin element, otherwise a security exception is thrown.
context
- contextgetBytes
- whether to include the actual document content
into the returned EbiDocVersion
EbiDocVersion
public Collection getAllVersions(EbiContext context, boolean getBytes) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
Security constraints:
The user whose context is passed in must have the Read access to
the document whose ID is passed in, or the Read access to the
Content Admin element, otherwise a security exception is thrown.
context
- contextgetBytes
- whether to put the actual content into the
returned EbiDocContent'sEbiDocVersion
's representing
Versions of the Document; the returned Versions are sorted
by the Version ID in descending order, so the latest version,
if there are any versions, is the first in the listEbiDocVersion
public void rollback(EbiContext context, int rollbackVersionID, boolean publish) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextrollbackVersionID
- the version number to roll back topublish
- if true, the version that the content is rolled back
to is publishedEbiContentMgmtDelegate.rollbackDocumentContent(com.sssw.fw.api.EbiContext, java.lang.String, int, boolean)
public void publishVersion(EbiContext context, int versionID, boolean force, boolean overwrite) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextversionID
- the ID of the Version that is to be publishedforce
- whether to force an immediate publish regardless of the
publish date set on the Documentoverwrite
- if set to true, any published Content that already
exists for the Document is overwritten with the specified Version; if
set to false, the method will throw an exception if it detects that
there is already a published VersionEbiDocVersion
public boolean unpublish(EbiContext context) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextpublic EbiDocLink linkTo(EbiContext context, EbiDocument linkDoc, boolean isLinkParent, int versionidChild, byte[] extnMeta) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextlinkDoc
- the Document to link toisLinkParent
- if true, this Document is to be the Link-Child,
otherwise it is to be the Link-ParentversionidChild
- Version ID to use for the Link-ChildextnMeta
- Extension Metadata for the LinkEbiDocLink
public EbiDocLink getLink(EbiContext context, EbiDocument linkDoc, boolean isLinkParent) throws EboUnrecoverableSystemException, EboSecurityException
context
- contextlinkDoc
- the Document that this Document is linked withisLinkParent
- if true, then this Document is assumed to be the
Link-Parent, otherwise it is assumed to be the Link-ChildEbiDocLink
public boolean removeLink(EbiContext context, EbiDocument linkDoc, boolean isLinkParent) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextlinkDoc
- the Document that this Document is linked toisLinkParent
- if true, then this Document is assumed to be the
Link-Parent, otherwise it is assumed to be the Link-Childpublic boolean updateLink(EbiContext context, EbiDocLink link) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextlink
- the Link to updatepublic Collection getLinkParents(EbiContext context, boolean checkAccess) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextcheckAccess
- if true, filter out the Documents in the resulting
Collection that the user whose context is passed in has no access,
otherwise return all the Link-Parent Documentspublic Collection getLinkChildren(EbiContext context, boolean checkAccess) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextcheckAccess
- if true, filter out the Documents in the resulting
Collection that the user whose context is passed in has no access,
otherwise return all the Link-Child DocumentsEbiDocument
's)EbiDocLink
public Collection getLinks(EbiContext context, boolean isLinkParent) throws EboUnrecoverableSystemException, EboSecurityException
context
- contextisLinkParent
- if true, then this Document is assumed to be the
Link-Parent, otherwise it is assumed to be the Link-ChildEbiLink
'sEbiDocLink
public Collection getCategoryReferences(EbiContext context, boolean checkAccess, boolean IDsOnly) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextcheckAccess
- if true, filter out the Categories in the resulting
Collection that the user whose context is passed in has no access,
otherwise return all the CategoriesIDsOnly
- if true, a Collection of category IDs (String's) is
returned, otherwise a Collection of EbiDocCategory
'sEbiDocCategory
's (if IDsOnly is false)EbiDocCategory
public boolean isInCategory(EbiContext context, EbiDocCategory category) throws EboUnrecoverableSystemException, EboSecurityException
context
- contextcategory
- CategoryEbiDocCategory
public void orphanChildren(EbiContext context) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextpublic void unlinkAll(EbiContext context, boolean isLinkParent, boolean doCheckOuts) throws EboUnrecoverableSystemException, EboSecurityException, EboItemExistenceException
context
- contextisLinkParent
- if true, treat this Document as a Link-Parent,
otherwise as Link-Child, in other words, if true, remove all the links
where this Document acts as a Link-Parent, otherwise all the links where
it acts as a Link-ChilddoCheckOuts
- if true, the method will do all the proper
checkouts of the Document itself and Link-Parents or Link-Children, and
will release all the locks after the operation is donepublic Collection findSimilar(EbiContext context, boolean checkAccess) throws EboUnrecoverableSystemException, EboSecurityException
context
- contextcheckAccess
- if true, perform the security filtering of query
resultscom.sssw.cm.api.EbiQueryResult
'sEbiQueryResult
|
Novell exteNd Director 5.2 API |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |