|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Editable
Defines the behaviour for editable objects within the API.
Editable objects may have their attributes set and changed.
Passing a null argument to a method of this interface will
result in a NullPointerException
, unless stated otherwise.
A successful call to methods in this interface other than
isChanged()
will result in a call to isChanged()
returning true.
Method Summary | |
---|---|
void |
addAuthors(java.lang.String[] authors)
Adds each author specified in the string array argument to the authors of this Editable object. |
void |
addCategoryIds(DocumentId<? extends Category>[] categoryIds)
Add categories to this document. |
void |
addContributorAccessMembers(java.lang.String[] members)
Deprecated. since 8.5 Use addMembersForAccess(Access, String[]) instead |
void |
addDeleteAccessMembers(java.lang.String[] members)
Deprecated. Use addMembersForAccess(Access, String[]) instead (using Access.MANAGER) |
void |
addEditAccessMembers(java.lang.String[] members)
Deprecated. Use addMembersForAccess(Access, String[]) instead (using Access.EDITOR) |
void |
addEditorAccessMembers(java.lang.String[] members)
Deprecated. since 8.5 Use addMembersForAccess(Access, String[]) instead |
void |
addHistoryLogEntry(java.lang.String message)
Adds a entry to the History log of this Editable
object. |
void |
addLiveAccessMembers(java.lang.String[] members)
Deprecated. Use addMembersForAccess(Access, String[]) instead (using Access.USER) |
void |
addManagerAccessMembers(java.lang.String[] members)
Deprecated. since 8.5 Use addMembersForAccess(Access, String[]) instead |
void |
addMembersForAccess(Access access,
java.lang.String[] members)
Adds each name specified in the string array argument to the members of the specified Access to this Editable
object. |
void |
addOwners(java.lang.String[] owners)
Adds each owner specified in the string array argument to the owners of this Editable object. |
void |
addReadAccessMembers(java.lang.String[] members)
Deprecated. Use addMembersForAccess(Access, String[]) instead (using Access.CONTRIBUTOR) |
void |
addUserAccessMembers(java.lang.String[] members)
Deprecated. since 8.5 Use addMembersForAccess(Access, String[]) instead |
boolean |
isChanged()
Returns the value of the changed flag. |
void |
removeAuthors(java.lang.String[] authors)
Removes each author specified in the string array argument from the authors of this Editable object. |
void |
removeCategoryIds(DocumentId<? extends Category>[] categoryIds)
Remove categories from this document. |
void |
removeContributorAccessMembers(java.lang.String[] members)
Deprecated. since 8.5 Use removeMembersForAccess(Access, String[]) instead |
void |
removeDeleteAccessMembers(java.lang.String[] members)
Deprecated. Use removeMembersForAccess(Access, String[]) instead (using Access.MANAGER) |
void |
removeEditAccessMembers(java.lang.String[] members)
Deprecated. Use removeMembersForAccess(Access, String[]) instead (using Access.EDITOR) |
void |
removeEditorAccessMembers(java.lang.String[] members)
Deprecated. since 8.5 Use removeMembersForAccess(Access, String[]) instead |
void |
removeLiveAccessMembers(java.lang.String[] members)
Deprecated. Use removeMembersForAccess(Access, String[]) instead (using Access.USER) |
void |
removeManagerAccessMembers(java.lang.String[] members)
Deprecated. since 8.5 Use removeMembersForAccess(Access, String[]) instead |
void |
removeMembersForAccess(Access access,
java.lang.String[] members)
Removes each name specified in the string array argument from the members of the specified Access level of this Editable
object. |
void |
removeOwners(java.lang.String[] owners)
Removes each owner specified in the string array argument from the owners of this Editable object. |
void |
removeReadAccessMembers(java.lang.String[] members)
Deprecated. Use removeMembersForAccess(Access, String[]) instead (using Access.CONTRIBUTOR) |
void |
removeUserAccessMembers(java.lang.String[] members)
Deprecated. since 8.5 Use removeMembersForAccess(Access, String[]) instead |
void |
setContributorAccessInheritance(boolean inheritContributors)
Deprecated. since 8.5 Use setInheritance(Access, boolean) instead |
void |
setDescriptionTextProviderKey(java.lang.String key)
Set the text provider key for the description of this item. |
void |
setDescriptionTextProviderName(java.lang.String name)
Set the text provider name for the description of this item. |
void |
setEditorAccessInheritance(boolean inheritEditors)
Deprecated. since 8.5 Use setInheritance(Access, boolean) instead |
void |
setInheritance(Access access,
boolean inheritedAccess)
Sets if the Access permissions will be inherited from the
parent of this Document . |
void |
setKeywords(java.lang.String[] keywords)
Sets the keywords for this document. |
void |
setManagerAccessInheritance(boolean inheritManagers)
Deprecated. since 8.5 Use setInheritance(Access, boolean) instead |
void |
setPropagation(Access access,
boolean propagateAccess)
Sets if the Access permissions will be propagated to the
children of this Document . |
void |
setTitleTextProviderKey(java.lang.String key)
Set the text provider key for the title of this item. |
void |
setTitleTextProviderName(java.lang.String name)
Set the text provider name for the title of this item. |
void |
setUserAccessInheritance(boolean inheritUsers)
Deprecated. since 8.5 Use setInheritance(Access, boolean) instead |
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 |
Methods inherited from interface com.ibm.workplace.wcm.api.EditableItem |
---|
setDescription, setName, setTitle |
Method Detail |
---|
boolean isChanged()
An Editable
object is deemed to have changed if one or
more attributes have been modified since it was last saved.
Editable
object has changed; false otherwisevoid setTitleTextProviderName(java.lang.String name)
PortalPage
.
name
- the text provider name for the titlevoid setTitleTextProviderKey(java.lang.String key)
PortalPage
.
key
- the text provider key for the titlevoid setDescriptionTextProviderName(java.lang.String name)
PortalPage
.
name
- the text provider name for the descriptionvoid setDescriptionTextProviderKey(java.lang.String key)
PortalPage
.
key
- the text provider key for the descriptionvoid addAuthors(java.lang.String[] authors)
Editable
object.
An author is only added if the element in the string array argument can be converted to a valid member.
Note: Each author of this Editable
object
must be unique. I.e. Duplicates are removed.
authors
- the authors to addvoid removeAuthors(java.lang.String[] authors)
Editable
object.
An author is only removed if the element in the string array
argument can be converted to a valid member and is already an
author on this Editable
object.
authors
- the authors names to removevoid addOwners(java.lang.String[] owners)
Editable
object.
An owner is only added if the element in the string array argument can be converted to a valid member.
Note: Each owner of this Editable
object must
be unique. I.e. Duplicates are removed.
Note: PortalPage
s can only have a single owner,
so adding an owner to a PortalPage
that already has an owner will cause
the existing owner to be replaced. Attempting to add multiple owners at once will cause
an IllegalArgumentException
owners
- the owners to add
java.lang.IllegalArgumentException
- If the array has length greater than 1 and this Editable
is a PortalPage
.void removeOwners(java.lang.String[] owners)
Editable
object.
An owner is only removed if the element in the string array
argument can be converted to a valid member and is already an
owner on this Editable
object.
owners
- the owners names to removevoid addLiveAccessMembers(java.lang.String[] members)
addMembersForAccess(Access, String[])
instead (using Access.USER)
Editable
object.
A name is only added if the element in the string array argument can be converted to a valid member.
Note: Each Live access member of this Editable
object must be unique. I.e. Duplicates are removed.
members
- the names of members to add to Live accessvoid addReadAccessMembers(java.lang.String[] members)
addMembersForAccess(Access, String[])
instead (using Access.CONTRIBUTOR)
Editable
object.
A name is only added if the element in the string array argument can be converted to a valid member.
Note: Each Read access member of this Editable
object must be unique. I.e. Duplicates are removed.
members
- the names of members to add to Read accessvoid addEditAccessMembers(java.lang.String[] members)
addMembersForAccess(Access, String[])
instead (using Access.EDITOR)
Editable
object.
A name is only added if the element in the string array argument can be converted to a valid member.
Note: Each Edit access member of this Editable
object must be unique. I.e. Duplicates are removed.
members
- the names of members to add to Edit accessvoid addDeleteAccessMembers(java.lang.String[] members)
addMembersForAccess(Access, String[])
instead (using Access.MANAGER)
Editable
object.
A name is only added if the element in the string array argument can be converted to a valid member.
Note: Each Delete access member of this Editable
object must be unique. I.e. Duplicates are removed.
members
- the names of members to add to Delete accessvoid addUserAccessMembers(java.lang.String[] members)
addMembersForAccess(Access, String[])
instead
Editable
object.
A name is only added if the element in the string array argument can be converted to a valid member.
Note: Each User access member of this Editable
object must be unique. I.e. Duplicates are removed.
members
- the names of members to add to User accessvoid addContributorAccessMembers(java.lang.String[] members)
addMembersForAccess(Access, String[])
instead
Editable
object.
A name is only added if the element in the string array argument can be converted to a valid member.
Note: Each Contributor access member of this Editable
object must be unique. I.e. Duplicates are removed.
members
- the names of members to add to Contributor accessvoid addEditorAccessMembers(java.lang.String[] members)
addMembersForAccess(Access, String[])
instead
Editable
object.
A name is only added if the element in the string array argument can be converted to a valid member.
Note: Each Editor access member of this Editable
object must be unique. I.e. Duplicates are removed.
members
- the names of members to add to Editor accessvoid addManagerAccessMembers(java.lang.String[] members)
addMembersForAccess(Access, String[])
instead
Editable
object.
A name is only added if the element in the string array argument can be converted to a valid member.
Note: Each Manager access member of this Editable
object must be unique. I.e. Duplicates are removed.
members
- the names of members to add to Manager accessvoid addMembersForAccess(Access access, java.lang.String[] members)
Editable
object.
A name is only added if the element in the string array argument can be converted to a valid member.
Note: Each Access member of this Document
object must be unique. I.e. Duplicates are removed.
access
- the access to add the members tomembers
- the names of members to addvoid removeLiveAccessMembers(java.lang.String[] members)
removeMembersForAccess(Access, String[])
instead (using Access.USER)
Editable
object.
A name is only removed if the element in the string array
argument can be converted to a valid member and already has
Live access to this Editable
object.
members
- the names of members to remove from Live accessvoid removeReadAccessMembers(java.lang.String[] members)
removeMembersForAccess(Access, String[])
instead (using Access.CONTRIBUTOR)
Editable
object.
A name is only removed if the element in the string array
argument can be converted to a valid member and already has
Read access to this Editable
object.
members
- the names of members to remove from
Read accessvoid removeEditAccessMembers(java.lang.String[] members)
removeMembersForAccess(Access, String[])
instead (using Access.EDITOR)
Editable
object.
A name is only removed if the element in the string array
argument can be converted to a valid member and already has
Edit access to this Editable
object.
members
- the names of members to remove from
Edit accessvoid removeDeleteAccessMembers(java.lang.String[] members)
removeMembersForAccess(Access, String[])
instead (using Access.MANAGER)
Editable
object.
A name is only removed if the element in the string array
argument can be converted to a valid member and already has
Delete access to this Editable
object.
members
- the names of members to remove from
Delete accessvoid removeUserAccessMembers(java.lang.String[] members)
removeMembersForAccess(Access, String[])
instead
Editable
object.
A name is only removed if the element in the string array
argument can be converted to a valid member and already has
User access to this Editable
object.
members
- the names of members to remove from User accessvoid removeContributorAccessMembers(java.lang.String[] members)
removeMembersForAccess(Access, String[])
instead
Editable
object.
A name is only removed if the element in the string array
argument can be converted to a valid member and already has
Contributor access to this Editable
object.
members
- the names of members to remove from
Contributor accessvoid removeEditorAccessMembers(java.lang.String[] members)
removeMembersForAccess(Access, String[])
instead
Editable
object.
A name is only removed if the element in the string array
argument can be converted to a valid member and already has
Editor access to this Editable
object.
members
- the names of members to remove from
Editor accessvoid removeManagerAccessMembers(java.lang.String[] members)
removeMembersForAccess(Access, String[])
instead
Editable
object.
A name is only removed if the element in the string array
argument can be converted to a valid member and already has
Manager access to this Editable
object.
members
- the names of members to remove from
Manager accessvoid removeMembersForAccess(Access access, java.lang.String[] members)
Editable
object.
A name is only removed if the element in the string array
argument can be converted to a valid member and already has
Access to this Editable
object.
access
- the access to remove the members frommembers
- the names of members to removevoid addHistoryLogEntry(java.lang.String message)
Editable
object.
The new History Log Entry will be created using the current API workspace user
message
- The message to add to the log.void setUserAccessInheritance(boolean inheritUsers)
setInheritance(Access, boolean)
instead
User
access permissions will be inherited from the
parent of this Document
.
inheritUsers
- true
to set user access permissions to be inherited,
or false
to block inheritance of permissions from the parent.void setContributorAccessInheritance(boolean inheritContributors)
setInheritance(Access, boolean)
instead
Contributor
access permissions will be inherited from the
parent of this Document
.
inheritContributors
- true
to set contributor access permissions to be inherited,
or false
to block inheritance of permissions from the parent.void setEditorAccessInheritance(boolean inheritEditors)
setInheritance(Access, boolean)
instead
Editor
access permissions will be inherited from the
parent of this Document
.
inheritEditors
- true
to set editor access permissions to be inherited,
or false
to block inheritance of permissions from the parent.void setManagerAccessInheritance(boolean inheritManagers)
setInheritance(Access, boolean)
instead
Manager
access permissions will be inherited from the
parent of this Document
.
inheritManagers
- true
to set manager access permissions to be inherited,
or false
to block inheritance of permissions from the parent.void setInheritance(Access access, boolean inheritedAccess)
Access
permissions will be inherited from the
parent of this Document
.
access
- the access to set the inheritance setting for.inheritedAccess
- true
to set access permissions to be inherited,
or false
to block inheriting of permissions.void setPropagation(Access access, boolean propagateAccess)
Access
permissions will be propagated to the
children of this Document
.
access
- the access to set the propagation setting for.propagateAccess
- true
to set access permissions to be propagated,
or false
to block Propagation of permissions.void addCategoryIds(DocumentId<? extends Category>[] categoryIds)
categoryIds
- the array of category IDs to addvoid removeCategoryIds(DocumentId<? extends Category>[] categoryIds)
categoryIds
- the array of category IDs to removevoid setKeywords(java.lang.String[] keywords)
keywords
- the array of keywords
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |