|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Document
An interface defining an object that exists as an entity in the repository.
This class extends
com.ibm.portal.Localized
which is documented in the WebSphere Portal
Infocenter. The class is located in wp.base.jar, so this jar needs to be in your
classpath.
'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. |
DocumentId<? extends Category>[] |
getCategoryIds()
Return array of IDs for the categories associated with this document. |
java.lang.String[] |
getContributorAccessMembers()
Deprecated. use getMembersForAccess(Access) |
java.lang.String |
getCreator()
Returns the name of creator of this Document object as a string. |
java.lang.String[] |
getDeleteAccessMembers()
Deprecated. Use getMembersForAccess(Access) instead (using Access.MANAGER) |
java.lang.String |
getDescription(java.util.Locale locale)
Returns the localized description of this Document object. |
java.lang.String |
getDescriptionTextProviderKey()
If a text provider has been configured, this method returns the text provider key for the description of this item. |
java.lang.String |
getDescriptionTextProviderName()
If a text provider has been configured, this method returns the text provider name for the description of this item. |
java.lang.String[] |
getEditAccessMembers()
Deprecated. Use getMembersForAccess(Access) instead |
java.lang.String[] |
getEditorAccessMembers()
Deprecated. use getMembersForAccess(Access) |
HistoryLogIterator |
getHistoryLog()
Returns the history log of this document |
DocumentId |
getId()
Returns the DocumentId of this Document object. |
java.lang.String[] |
getInheritedContributorAccessMembers()
Deprecated. use getMembersForInheritedAccess(Access) |
java.lang.String[] |
getInheritedEditorAccessMembers()
Deprecated. use getMembersForInheritedAccess(Access) |
java.lang.String[] |
getInheritedManagerAccessMembers()
Deprecated. use getMembersForInheritedAccess(Access) |
java.lang.String[] |
getInheritedUserAccessMembers()
Deprecated. use getMembersForInheritedAccess(Access) |
java.lang.String[] |
getKeywords()
Returns an array of keywords associated with this document. |
java.lang.String |
getLastModifier()
Returns the distinguished name of the last modifier of this item. |
java.lang.String[] |
getLiveAccessMembers()
Deprecated. Use getMembersForAccess(Access) instead |
java.lang.String[] |
getManagerAccessMembers()
Deprecated. use getMembersForAccess(Access) |
java.lang.String[] |
getMembersForAccess(Access access)
Get the members who have the specified access explicitly granted on this Document object. |
java.lang.String[] |
getMembersForInheritedAccess(Access access)
Get the members who have inherited the specified access on 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. |
Project |
getProject()
Return Project if this Document is in a Project. |
java.lang.String[] |
getReadAccessMembers()
Deprecated. Use getMembersForAccess(Access) instead (using Access.CONTRIBUTOR) |
Workspace |
getSourceWorkspace()
Returns the Workspace of this Document object. |
java.lang.String |
getTitle(java.util.Locale locale)
Returns the localized title of this Document object. |
java.lang.String |
getTitleTextProviderKey()
If a text provider has been configured, this method returns the text provider key for the title of this item. |
java.lang.String |
getTitleTextProviderName()
If a text provider has been configured, this method returns the text provider name for the title of this item. |
java.lang.String[] |
getUserAccessMembers()
Deprecated. use getMembersForAccess(Access) instead |
VersionCatalog |
getVersionCatalog()
Use the VersionCatalog to access all available versions that exist for this Document |
VersionStrategy |
getVersionStrategy()
Retrieve the version strategy for this item. |
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 |
hasProfile()
Indicates if the current document has a profile |
boolean |
hasProject()
Return true if this Document is in a Project. |
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()
Deprecated. since 8.5 Use isInherited(Access) instead |
boolean |
isEditorAccessInherited()
Deprecated. since 8.5 Use isInherited(Access) instead |
boolean |
isInherited(Access access)
Check whether the permissions for the selected Access level are inherited from
the parent of this Document . |
boolean |
isManagerAccessInherited()
Deprecated. since 8.5 Use isInherited(Access) instead |
boolean |
isNew()
Return true if this Document is new and unsaved. |
boolean |
isPropagated(Access access)
Check whether the permissions for the selected Access level are propagated
to the children of this Document . |
boolean |
isUserAccessInherited()
Deprecated. since 8.5 Use isInherited(Access) instead |
boolean |
isWorkflowed()
Return true if this Document object is workflowed. |
Methods inherited from interface com.ibm.workplace.wcm.api.Item |
---|
getCreationDate, getDescription, getIdentity, getModifiedDate, getName, getTitle |
Methods inherited from interface com.ibm.portal.Localized |
---|
getLocales |
Method Detail |
---|
Workspace getSourceWorkspace()
Workspace
of this Document
object.
Workspace
of this Document
DocumentId getId()
DocumentId
of this Document
object.
Note. Calling this method on a Document
that does not have
a name set will result in a NullPointerException
.
DocumentId
of this Document
java.lang.NullPointerException
- if the name of this Document
has not
been setjava.lang.String getTitle(java.util.Locale locale)
Document
object.
If a text provider has been configured, the localized title retrieved from the
text provider will be returned. If no text provider is configured, the non-localized title
of this Document
object will be returned.
getTitle
in interface Localized
locale
- the locale to use when localizing the title
java.lang.String getTitleTextProviderName()
java.lang.String getTitleTextProviderKey()
java.lang.String getDescription(java.util.Locale locale)
Document
object.
If a text provider has been configured, the localized description retrieved from the
text provider will be returned. If no text provider is configured, the non-localized description
of this Document
object will be returned.
getDescription
in interface Localized
locale
- the locale to use when localizing the description
Returns null if this Document does not have a description.
java.lang.String getDescriptionTextProviderName()
java.lang.String getDescriptionTextProviderKey()
java.lang.String[] getAuthors()
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.
java.lang.String[] getOwners()
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.
java.lang.String getCreator()
Document
object as a string. The string is either the
user's common name or distinguished name, depending on the setting
on the Workspace. See Workspace.isDistinguishedNamesUsed()
.
java.lang.String[] getLiveAccessMembers()
getMembersForAccess(Access)
instead
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.
Document
object.java.lang.String[] getUserAccessMembers()
getMembersForAccess(Access)
instead
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()
Document
object.java.lang.String[] getReadAccessMembers()
getMembersForAccess(Access)
instead (using Access.CONTRIBUTOR)
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.
Document
object.java.lang.String[] getContributorAccessMembers()
getMembersForAccess(Access)
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()
Document
object.java.lang.String[] getEditAccessMembers()
getMembersForAccess(Access)
instead
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.
Document
object.java.lang.String[] getEditorAccessMembers()
getMembersForAccess(Access)
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()
Document
object.java.lang.String[] getInheritedContributorAccessMembers()
getMembersForInheritedAccess(Access)
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.
Document
object.java.lang.String[] getInheritedEditorAccessMembers()
getMembersForInheritedAccess(Access)
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.
Document
object.java.lang.String[] getInheritedManagerAccessMembers()
getMembersForInheritedAccess(Access)
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.
Document
object.java.lang.String[] getInheritedUserAccessMembers()
getMembersForInheritedAccess(Access)
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.
Document
object.java.lang.String[] getDeleteAccessMembers()
getMembersForAccess(Access)
instead (using Access.MANAGER)
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.
Document
object.java.lang.String[] getManagerAccessMembers()
getMembersForAccess(Access)
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()
Document
object.java.lang.String[] getMembersForAccess(Access access)
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 no user is explicitly granted the specified access on this Document
object.
Note: This method does not return members who have inherited the specified access.
To get array of members who have inherited the specified access use getMembersForInheritedAccess(Access)
access
- the access to query the members for.
Document
object.java.lang.String[] getMembersForInheritedAccess(Access access)
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 no user has inherited the specified access on this Document
object.
access
- the access to query the members who have inherited it.
Document
object.DocumentLibrary getOwnerLibrary()
Document
object is
stored.
Returns null
if this Document
object
has not been saved.
DocumentLibrary
that this Document
object is stored in.HistoryLogIterator getHistoryLog()
The returned iterator iterates over HistoryLogEntry
objects.
HistoryLogIterator
, never nullboolean hasLiveAccess(UserProfile user) throws com.ibm.workplace.wcm.api.exceptions.OperationFailedException
Workspace.hasContributorAccess(DocumentId documentId)
instead
UserProfile
has Live access to this document.
user
- the UserProfile
to perform the access check for
com.ibm.workplace.wcm.api.exceptions.OperationFailedException
- if error occured when accessing repositoryboolean hasReadAccess(UserProfile user) throws com.ibm.workplace.wcm.api.exceptions.OperationFailedException
Workspace.hasContributorAccess(DocumentId documentId)
instead
UserProfile
has Read access to this document.
user
- the UserProfile
to perform the access check for
com.ibm.workplace.wcm.api.exceptions.OperationFailedException
- if error occured when accessing repositoryboolean hasEditAccess(UserProfile user) throws com.ibm.workplace.wcm.api.exceptions.OperationFailedException
Workspace.hasEditorAccess(DocumentId documentId)
instead
UserProfile
has Edit access to this document.
user
- the UserProfile
to perform the access check for
com.ibm.workplace.wcm.api.exceptions.OperationFailedException
- if error occured when accessing repositoryboolean hasDeleteAccess(UserProfile user) throws com.ibm.workplace.wcm.api.exceptions.OperationFailedException
Workspace.hasManagerAccess(DocumentId documentId)
instead
UserProfile
has Delete access to this document.
user
- the UserProfile
to perform the access check for
com.ibm.workplace.wcm.api.exceptions.OperationFailedException
- if error occured when accessing repositoryboolean hasLiveAccess() throws com.ibm.workplace.wcm.api.exceptions.OperationFailedException
Workspace.hasContributorAccess(DocumentId documentId)
instead
Workspace
associated with the current Document has
Live access to this Document
object.
com.ibm.workplace.wcm.api.exceptions.OperationFailedException
- if error occured when accessing repositoryboolean hasReadAccess() throws com.ibm.workplace.wcm.api.exceptions.OperationFailedException
Workspace.hasContributorAccess(DocumentId documentId)
instead
Workspace
associated with the current Document has
Read access to this Document
object.
com.ibm.workplace.wcm.api.exceptions.OperationFailedException
- if error occured when accessing repositoryboolean hasEditAccess() throws com.ibm.workplace.wcm.api.exceptions.OperationFailedException
Workspace.hasEditorAccess(DocumentId documentId)
instead
Workspace
associated with the current Document has
Edit access to this Document
object.
com.ibm.workplace.wcm.api.exceptions.OperationFailedException
- if error occured when accessing repositoryboolean hasDeleteAccess() throws com.ibm.workplace.wcm.api.exceptions.OperationFailedException
Workspace.hasManagerAccess(DocumentId documentId)
instead
UserProfile
has Delete access to this document.
Delete access to this Document
object.
com.ibm.workplace.wcm.api.exceptions.OperationFailedException
- if error occured when accessing repositoryboolean isUserAccessInherited()
isInherited(Access)
instead
User
access permissions will be inherited from the
parent of this Document
.
boolean isContributorAccessInherited()
isInherited(Access)
instead
Contributor
access permissions will be inherited from the
parent of this Document
.
boolean isEditorAccessInherited()
isInherited(Access)
instead
Editor
access permissions will be inherited from the
parent of this Document
.
boolean isManagerAccessInherited()
isInherited(Access)
instead
Manager
access permissions will be inherited from the
parent of this Document
.
boolean isPropagated(Access access)
Access
level are propagated
to the children of this Document
.
access
- the access to query the propagation for.
boolean isInherited(Access access)
Access
level are inherited from
the parent of this Document
.
access
- the access to query the inheritance setting for.
boolean isWorkflowed()
Document
object is workflowed.
boolean hasProject()
Document
is in a Project.
boolean isNew()
Document
is new and unsaved.
Document
is new and unsaved.Project getProject()
Document
is in a Project.
Consider calling hasProject()
where appropriate, as this method can return null.
VersionCatalog getVersionCatalog()
Document
Document
java.lang.String getLastModifier()
VersionStrategy getVersionStrategy()
The version strategy defines the policy for controlling when the item is versioned. By default the version strategy is globally configured per type in WCM config properties. Items that are templatable can have the global configuration overridden by the template.
Note that workflowed items in a draft state are never versioned and so the strategy does not directly apply to drafts.
VersionStrategy
of this itemDocumentId<? extends Category>[] getCategoryIds()
boolean hasProfile()
java.lang.String[] getKeywords()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |