com.ibm.workplace.wcm.api
Interface Document

All Known Subinterfaces:

AuthoringTemplate, Category, Content, ContentComponentContainer, ContentLink, Editable, EditableLibraryComponent, LibraryComponent, LibraryDateComponent, LibraryDocumentManagerComponent, LibraryFileComponent, LibraryHTMLComponent, LibraryImageComponent, LibraryLinkComponent, LibraryNumericComponent, LibraryRichTextComponent, LibraryShortTextComponent, LibraryStyleSheetComponent, LibraryTextComponent, LibraryUserSelectionComponent, PresentationTemplate, Site, SiteArea, SiteFrameworkContainer, Taxonomy, Workflow, WorkflowStage

public interface Document

An interface defining an object that exists as an entity in the repository. 'Live' access has been removed from WCM. 'Live' access methods are deprecated and 'Read' access method calls should be used instead. Calling 'Live' access methods have the same effect as calling 'Read' access.

Method Summary

java.lang.String[]	getAuthors() Returns the names of authors of this Document object as a string array.
java.lang.String[]	getContributorAccessMembers() Returns a string array of members who have Contributor access to this Document object.
java.lang.String[]	getDeleteAccessMembers() Deprecated. Use getManagerAccessMembers() instead
java.lang.String	getDescription() Returns the description of this Document object.
java.lang.String[]	getEditAccessMembers() Deprecated. Use getEditorAccessMembers() instead
java.lang.String[]	getEditorAccessMembers() Returns a string array of members who have Editor access to this Document object.
HistoryLogIterator	getHistoryLog() Returns the history log of this document
DocumentId	getId() Returns the DocumentId of this Document object.
java.lang.String[]	getInheritedContributorAccessMembers() Returns a string array of members who have inherited Contributor access to this Document object.
java.lang.String[]	getInheritedEditorAccessMembers() Returns a string array of members who have inherited Editor access to this Document object.
java.lang.String[]	getInheritedManagerAccessMembers() Returns a string array of members who have inherited Manager access to this Document object.
java.lang.String[]	getInheritedUserAccessMembers() Returns a string array of members who have inherited User access to this Document object.
java.lang.String[]	getLiveAccessMembers() Deprecated. Use getUserAccessMembers() instead
java.lang.String[]	getManagerAccessMembers() Returns a string array of members who have Manager access to this Document object.
java.util.Date	getModifiedDate() Returns the modified date of this document
java.lang.String	getName() Returns the name of this Document object.
DocumentLibrary	getOwnerLibrary() Returns the library in which this Document object is stored.
java.lang.String[]	getOwners() Returns the names of owners of this Document object as a string array.
java.lang.String[]	getReadAccessMembers() Deprecated. Use getContributorAccessMembers() instead
Workspace	getSourceWorkspace() Returns the Workspace of this Document object.
java.lang.String	getTitle() Returns the title of the controllable object that this Document refers to.
java.lang.String[]	getUserAccessMembers() Returns a string array of members who have User access to this Document object.
boolean	hasDeleteAccess() Deprecated. This method is deprecated from version 6.0. Calls to This method will be deprecated in the future. Calls to 'Delete' access methods have the same effect as 'Manager' access method calls. Use Workspace.hasManagerAccess(DocumentId documentId) instead
boolean	hasDeleteAccess(UserProfile user) Deprecated. This method is deprecated from version 6.0. Calls to This method will be deprecated in the future. Calls to 'Delete' access methods have the same effect as 'Manager' access method calls. Use Workspace.hasManagerAccess(DocumentId documentId) instead
boolean	hasEditAccess() Deprecated. This method is deprecated from version 6.0. Calls to This method will be deprecated in the future. Calls to 'Edit' access methods have the same effect as 'Editor' access method calls. Use Workspace.hasEditorAccess(DocumentId documentId) instead
boolean	hasEditAccess(UserProfile user) Deprecated. This method is deprecated from version 6.0. Calls to This method will be deprecated in the future. Calls to 'Edit' access methods have the same effect as 'Editor' access method calls. Use Workspace.hasEditorAccess(DocumentId documentId) instead
boolean	hasLiveAccess() Deprecated. This method is deprecated from version 6.0. Calls to 'Live' access methods have the same effect as 'Contributor' access method calls. Use Workspace.hasContributorAccess(DocumentId documentId) instead
boolean	hasLiveAccess(UserProfile user) Deprecated. This method is deprecated from version 6.0. Calls to 'Live' access methods have the same effect as 'Contributor' access method calls. Use Workspace.hasContributorAccess(DocumentId documentId) instead
boolean	hasReadAccess() Deprecated. This method is deprecated from version 6.0. Calls to 'Live' access methods have the same effect as 'Contributor' access method calls. Use Workspace.hasContributorAccess(DocumentId documentId) instead
boolean	hasReadAccess(UserProfile user) Deprecated. This method is deprecated from version 6.0. Calls to 'Live' access methods have the same effect as 'Contributor' access method calls. Use Workspace.hasContributorAccess(DocumentId documentId) instead
boolean	isContributorAccessInherited() Checks if the Contributor access permissions will be inherited from the parent of this Document.
boolean	isEditorAccessInherited() Checks if the Editor access permissions will be inherited from the parent of this Document.
boolean	isManagerAccessInherited() Checks if the Manager access permissions will be inherited from the parent of this Document.
boolean	isUserAccessInherited() Checks if the User access permissions will be inherited from the parent of this Document.
boolean	isWorkflowed() Return true if this Document object is workflowed.

Method Detail

getSourceWorkspace

Workspace getSourceWorkspace()

Returns the Workspace of this Document object.

Returns:

the Workspace of this Document

getId

DocumentId getId()

Returns the DocumentId of this Document object.

Note. Calling this method on a Document that does not have a name set will result in a NullPointerException.

Returns:

the DocumentId of this Document

Throws:

java.lang.NullPointerException - if the name of this Document has not been set

getName

java.lang.String getName()

Returns the name of this Document object.

Returns null if this Document does not have a name.

Returns:

the name of this Document object.

getTitle

java.lang.String getTitle()

Returns the title of the controllable object that this Document refers to. If the document does not have a title then the name is returned.

Returns null if this Document does not have a title or a name.

Returns:

the title of the controllable object that this Document refers to.

getDescription

java.lang.String getDescription()

Returns the description of this Document object.

Returns null if this Document object does not have a description.

Returns:

the description

getAuthors

java.lang.String[] getAuthors()

Returns the names of authors of this Document object as a string array. The strings are either the users' common name or distinguished name, depending on the setting on the Workspace. See Workspace.isDistinguishedNamesUsed().

The resultant array may contain the names of users or groups.

Returns an empty array if this Document object has no authors.

Returns:

a string array of author common names or distinguished names

getOwners

java.lang.String[] getOwners()

Returns the names of owners of this Document object as a string array. The strings are either the users' common name or distinguished name, depending on the setting on the Workspace. See Workspace.isDistinguishedNamesUsed().

The resultant array may contain the names of users or groups.

Returns an empty array if this Document object has no owners.

Returns:

a string array of owner common names or distinguished names

getLiveAccessMembers

java.lang.String[] getLiveAccessMembers()

Deprecated. Use getUserAccessMembers() instead

Returns a string array of members who have Live access to this Document object. The strings are either the users' common name or distinguished name, depending on the setting on the Workspace. See Workspace.isDistinguishedNamesUsed().

The resultant array may contain the names of users or groups.

Returns an empty array if this Document object does not have Live access specified.

Returns:

a string array of members that have Live access to this Document object.

getUserAccessMembers

java.lang.String[] getUserAccessMembers()

Returns a string array of members who have User access to this Document object. The strings are either the users' common name or distinguished name, depending on the setting on the Workspace. See Workspace.isDistinguishedNamesUsed().

The resultant array may contain the names of users or groups.

Returns an empty array if this Document object does not have User access specified.

This method does not return array of members who have inherited User access.
To get array of members who have inherited User access use getInheritedUserAccessMembers()

Returns:

a string array of members that have User access to this Document object.

getReadAccessMembers

java.lang.String[] getReadAccessMembers()

Deprecated. Use getContributorAccessMembers() instead

Returns a string array of members who have Read access to this Document object. The strings are either the users' common name or distinguished name, depending on the setting on the Workspace. See Workspace.isDistinguishedNamesUsed().

The resultant array may contain the names of users and groups.

Returns an empty array if this Document object does not have Read access specified.

Returns:

a string array of members that have Read access to this Document object.

getContributorAccessMembers

java.lang.String[] getContributorAccessMembers()

Returns a string array of members who have Contributor access to this Document object. The strings are either the users' common name or distinguished name, depending on the setting on the Workspace. See Workspace.isDistinguishedNamesUsed().

The resultant array may contain the names of users and groups.

Returns an empty array if this Document object does not have Contributor access specified.

This method does not return array of members who have inherited Contributor access.
To get array of members who have inherited Contributor access use getInheritedContributorAccessMembers()

Returns:

a string array of members that have Contributor access to this Document object.

getEditAccessMembers

java.lang.String[] getEditAccessMembers()

Deprecated. Use getEditorAccessMembers() instead

Returns a string array of members who have Edit access to this Document object. The strings are either the users' common name or distinguished name, depending on the setting on the Workspace. See Workspace.isDistinguishedNamesUsed().

The resultant array may contain the names of users and groups.

Returns an empty array if this Document object does not have Edit access specified.

Returns:

a string array of members that have Edit access to this Document object.

getEditorAccessMembers

java.lang.String[] getEditorAccessMembers()

Returns a string array of members who have Editor access to this Document object. The strings are either the users' common name or distinguished name, depending on the setting on the Workspace. See Workspace.isDistinguishedNamesUsed().

The resultant array may contain the names of users and groups.

Returns an empty array if this Document object does not have Editor access specified.

This method does not return array of members who have inherited Editor access.
To get array of members who have inherited Editor access use getInheritedEditorAccessMembers()

Returns:

a string array of members that have Editor access to this Document object.

getInheritedContributorAccessMembers

java.lang.String[] getInheritedContributorAccessMembers()

Returns a string array of members who have inherited Contributor access to this Document object. The strings are either the users' common name or distinguished name, depending on the setting on the Workspace. See Workspace.isDistinguishedNamesUsed().

The resultant array may contain the names of users or groups.

Returns an empty array if this Document object does not have inherited Contributor access specified.

Returns:

a string array of members that have inherited Contributor access to this Document object.

getInheritedEditorAccessMembers

java.lang.String[] getInheritedEditorAccessMembers()

Returns a string array of members who have inherited Editor access to this Document object. The strings are either the users' common name or distinguished name, depending on the setting on the Workspace. See Workspace.isDistinguishedNamesUsed().

The resultant array may contain the names of users or groups.

Returns an empty array if this Document object does not have inherited Editor access specified.

Returns:

a string array of members that have inherited Editor access to this Document object.

getInheritedManagerAccessMembers

java.lang.String[] getInheritedManagerAccessMembers()

Returns a string array of members who have inherited Manager access to this Document object. The strings are either the users' common name or distinguished name, depending on the setting on the Workspace. See Workspace.isDistinguishedNamesUsed().

The resultant array may contain the names of users or groups.

Returns an empty array if this Document object does not have inherited Manager access specified.

Returns:

a string array of members that have inherited Manager access to this Document object.

getInheritedUserAccessMembers

java.lang.String[] getInheritedUserAccessMembers()

Returns a string array of members who have inherited User access to this Document object. The strings are either the users' common name or distinguished name, depending on the setting on the Workspace. See Workspace.isDistinguishedNamesUsed().

The resultant array may contain the names of users or groups.

Returns an empty array if this Document object does not have inherited User access specified.

Returns:

a string array of members that have inherited User access to this Document object.

getDeleteAccessMembers

java.lang.String[] getDeleteAccessMembers()

Deprecated. Use getManagerAccessMembers() instead

Returns a string array of members who have Delete access to this Document object. The strings are either the users' common name or distinguished name, depending on the setting on the Workspace. See Workspace.isDistinguishedNamesUsed().

The resultant array may contain the names of users and groups.

Returns an empty array if this Document object does not have Delete access specified.

Returns:

a string array of members that have Delete access to this Document object.

getManagerAccessMembers

java.lang.String[] getManagerAccessMembers()

Returns a string array of members who have Manager access to this Document object. The strings are either the users' common name or distinguished name, depending on the setting on the Workspace. See Workspace.isDistinguishedNamesUsed().

The resultant array may contain the names of users and groups.

Returns an empty array if this Document object does not have Manager access specified.

This method does not return array of members who have inherited Manager access.
To get array of members who have inherited Manager access use getInheritedManagerAccessMembers()

Returns:

a string array of members that have Manager access to this Document object.

getOwnerLibrary

DocumentLibrary getOwnerLibrary()

Returns the library in which this Document object is stored.

Returns null if this Document object has not been saved.

Returns:

the DocumentLibrary that this Document object is stored in.

getModifiedDate

java.util.Date getModifiedDate()

Returns the modified date of this document

Returns:

returns the modified date of this document

getHistoryLog

HistoryLogIterator getHistoryLog()

Returns the history log of this document

The returned iterator iterates over HistoryLogEntry objects.

Returns:

a HistoryLogIterator, never null

hasLiveAccess

boolean hasLiveAccess(UserProfile user)
                      throws OperationFailedException

Deprecated. This method is deprecated from version 6.0. Calls to 'Live' access methods have the same effect as 'Contributor' access method calls. Use Workspace.hasContributorAccess(DocumentId documentId) instead

Checks if the UserProfile has Live access to this document.

Parameters:

user - the UserProfile to perform the access check for

Returns:

true if this user has Live access, false if not

Throws:

OperationFailedException - if error occured when accessing repository

hasReadAccess

boolean hasReadAccess(UserProfile user)
                      throws OperationFailedException

Deprecated. This method is deprecated from version 6.0. Calls to 'Live' access methods have the same effect as 'Contributor' access method calls. Use Workspace.hasContributorAccess(DocumentId documentId) instead

Checks if the UserProfile has Read access to this document.

Parameters:

user - the UserProfile to perform the access check for

Returns:

true if this user has Read access, false if not

Throws:

OperationFailedException - if error occured when accessing repository

hasEditAccess

boolean hasEditAccess(UserProfile user)
                      throws OperationFailedException

Deprecated. This method is deprecated from version 6.0. Calls to This method will be deprecated in the future. Calls to 'Edit' access methods have the same effect as 'Editor' access method calls. Use Workspace.hasEditorAccess(DocumentId documentId) instead

Checks if the UserProfile has Edit access to this document.

Parameters:

user - the UserProfile to perform the access check for

Returns:

true if this user has Edit access, false if not

Throws:

OperationFailedException - if error occured when accessing repository

hasDeleteAccess

boolean hasDeleteAccess(UserProfile user)
                        throws OperationFailedException

Deprecated. This method is deprecated from version 6.0. Calls to This method will be deprecated in the future. Calls to 'Delete' access methods have the same effect as 'Manager' access method calls. Use Workspace.hasManagerAccess(DocumentId documentId) instead

Checks if the UserProfile has Delete access to this document.

Parameters:

user - the UserProfile to perform the access check for

Returns:

true if this user has Delete access, false if not

Throws:

OperationFailedException - if error occured when accessing repository

hasLiveAccess

boolean hasLiveAccess()
                      throws OperationFailedException

Deprecated. This method is deprecated from version 6.0. Calls to 'Live' access methods have the same effect as 'Contributor' access method calls. Use Workspace.hasContributorAccess(DocumentId documentId) instead

Checks if the user of the Workspace associated with the current Document has Live access to this Document object.

Returns:

true if this user has Live access, false if not

Throws:

OperationFailedException - if error occured when accessing repository

hasReadAccess

boolean hasReadAccess()
                      throws OperationFailedException

Deprecated. This method is deprecated from version 6.0. Calls to 'Live' access methods have the same effect as 'Contributor' access method calls. Use Workspace.hasContributorAccess(DocumentId documentId) instead

Checks if the user of the Workspace associated with the current Document has Read access to this Document object.

Returns:

true if this user has Read access, false if not

Throws:

OperationFailedException - if error occured when accessing repository

hasEditAccess

boolean hasEditAccess()
                      throws OperationFailedException

Deprecated. This method is deprecated from version 6.0. Calls to This method will be deprecated in the future. Calls to 'Edit' access methods have the same effect as 'Editor' access method calls. Use Workspace.hasEditorAccess(DocumentId documentId) instead

Checks if the user of the Workspace associated with the current Document has Edit access to this Document object.

Returns:

true if this user has Edit access, false if not

Throws:

OperationFailedException - if error occured when accessing repository

hasDeleteAccess

boolean hasDeleteAccess()
                        throws OperationFailedException

Deprecated. This method is deprecated from version 6.0. Calls to This method will be deprecated in the future. Calls to 'Delete' access methods have the same effect as 'Manager' access method calls. Use Workspace.hasManagerAccess(DocumentId documentId) instead

Checks if the UserProfile has Delete access to this document. Delete access to this Document object.

Returns:

true if this user has Delete access, false if not

Throws:

OperationFailedException - if error occured when accessing repository

isUserAccessInherited

boolean isUserAccessInherited()

Checks if the User access permissions will be inherited from the parent of this Document.

Returns:

true if user permissions are inherited, false if not

isContributorAccessInherited

boolean isContributorAccessInherited()

Checks if the Contributor access permissions will be inherited from the parent of this Document.

Returns:

true if user permissions are inherited, false if not

isEditorAccessInherited

boolean isEditorAccessInherited()

Checks if the Editor access permissions will be inherited from the parent of this Document.

Returns:

true if user permissions are inherited, false if not

isManagerAccessInherited

boolean isManagerAccessInherited()

Checks if the Manager access permissions will be inherited from the parent of this Document.

Returns:

true if user permissions are inherited, false if not

isWorkflowed

boolean isWorkflowed()

Return true if this Document object is workflowed.

Returns:

true if it is workflowed