Overview Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
com.ibm.workplace.wcm.api
Interface Editable
- All Superinterfaces:
- Document
- All Known Subinterfaces:
- Category, Content, ContentComponentContainer, EditableLibraryComponent, LibraryDateComponent, LibraryDocumentManagerComponent, LibraryFileComponent, LibraryHTMLComponent, LibraryImageComponent, LibraryJSPComponent, LibraryLinkComponent, LibraryNumericComponent, LibraryRichTextComponent, LibraryShortTextComponent, LibraryStyleSheetComponent, LibraryTextComponent, LibraryUserSelectionComponent, PresentationTemplate, Site, SiteArea, SiteFrameworkContainer, Taxonomy
public interface Editable- extends Document
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 addContributorAccessMembers(java.lang.String[] members)
Adds each name specified in the string array argument to the members who have Contributor access to this Editable object.void addDeleteAccessMembers(java.lang.String[] members)
Deprecated. Use addManagerAccessMembers(String[]) insteadvoid addEditAccessMembers(java.lang.String[] members)
Deprecated. Use addEditorAccessMembers(String[]) insteadvoid addEditorAccessMembers(java.lang.String[] members)
Adds each name specified in the string array argument to the members who have Editor access to this Editable object.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 addUserAccessMembers(String[]) insteadvoid addManagerAccessMembers(java.lang.String[] members)
Adds each name specified in the string array argument to the members who have Manager 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 addContributorAccessMembers(String[]) insteadvoid addUserAccessMembers(java.lang.String[] members)
Adds each name specified in the string array argument to the members who have User access to this Editable object.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 removeContributorAccessMembers(java.lang.String[] members)
Removes each name specified in the string array argument from the members who have Contributor access to this Editable object.void removeDeleteAccessMembers(java.lang.String[] members)
Deprecated. Use removeManagerAccessMembers(String[]) insteadvoid removeEditAccessMembers(java.lang.String[] members)
Deprecated. Use removeEditorAccessMembers(String[]) insteadvoid removeEditorAccessMembers(java.lang.String[] members)
Removes each name specified in the string array argument from the members who have Editor access to this Editable object.void removeLiveAccessMembers(java.lang.String[] members)
Deprecated. Use removeUserAccessMembers(String[]) insteadvoid removeManagerAccessMembers(java.lang.String[] members)
Removes each name specified in the string array argument from the members who have Manager access to 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 removeContributorAccessMembers(String[]) insteadvoid removeUserAccessMembers(java.lang.String[] members)
Removes each name specified in the string array argument from the members who have User access to this Editable object.void setContributorAccessInheritance(boolean inheritContributors)
Sets if the Contributor access permissions will be inherited from the parent of this Document.void setDescription(java.lang.String description)
Sets the description of this Editable object to the specified String argument.void setEditorAccessInheritance(boolean inheritEditors)
Sets if the Editor access permissions will be inherited from the parent of this Document.void setManagerAccessInheritance(boolean inheritManagers)
Sets if the Manager access permissions will be inherited from the parent of this Document.void setName(java.lang.String name)
Sets the name of this Editable object to the specified String argument.void setTitle(java.lang.String title)
Sets the title of this Editable object to the specified String argument.void setUserAccessInheritance(boolean inheritUsers)
Sets if the User access permissions will be inherited from the parent of this Document.
Method Detail isChanged
boolean isChanged()
- Returns the value of the changed flag.
An Editable object is deemed to have changed if one or more attributes have been modified since it was last saved.
- Returns:
- true if at least one attribute of this Editable object has changed; false otherwise
setName
void setName(java.lang.String name)
- Sets the name of this Editable object to the specified String argument.
- Parameters:
- name - of the editable
setTitle
void setTitle(java.lang.String title)
- Sets the title of this Editable object to the specified String argument.
- Parameters:
- title - of the editable
setDescription
void setDescription(java.lang.String description)
- Sets the description of this Editable object to the specified String argument.
This method accepts a null argument.
- Parameters:
- description - of the editable
addAuthors
void addAuthors(java.lang.String[] authors)
- Adds each author specified in the string array argument to the authors of this 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.
- Parameters:
- authors - the authors to add
removeAuthors
void removeAuthors(java.lang.String[] authors)
- Removes each author specified in the string array argument from the authors of this Editable object.
An author is only removed if the element in the string array argument can be converted to a valid member and already an author on this Editable object.
- Parameters:
- authors - the authors names to remove
addOwners
void addOwners(java.lang.String[] owners)
- Adds each owner specified in the string array argument to the owners of this 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.
- Parameters:
- owners - the owners to add
removeOwners
void removeOwners(java.lang.String[] owners)
- Removes each owner specified in the string array argument from the owners of this Editable object.
An owner is only removed if the element in the string array argument can be converted to a valid member and already an owner on this Editable object.
- Parameters:
- owners - the owners names to remove
addLiveAccessMembers
void addLiveAccessMembers(java.lang.String[] members)
- Deprecated. Use addUserAccessMembers(String[]) instead
- Adds each name specified in the string array argument to the members who have Live access to this 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.
- Parameters:
- members - the names of members to add to Live access
addReadAccessMembers
void addReadAccessMembers(java.lang.String[] members)
- Deprecated. Use addContributorAccessMembers(String[]) instead
- Adds each name specified in the string array argument to the members who have Read access to this 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.
- Parameters:
- members - the names of members to add to Read access
addEditAccessMembers
void addEditAccessMembers(java.lang.String[] members)
- Deprecated. Use addEditorAccessMembers(String[]) instead
- Adds each name specified in the string array argument to the members who have Edit access to this 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.
- Parameters:
- members - the names of members to add to Edit access
addDeleteAccessMembers
void addDeleteAccessMembers(java.lang.String[] members)
- Deprecated. Use addManagerAccessMembers(String[]) instead
- Adds each name specified in the string array argument to the members who have Delete access to this 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.
- Parameters:
- members - the names of members to add to Delete access
addUserAccessMembers
void addUserAccessMembers(java.lang.String[] members)
- Adds each name specified in the string array argument to the members who have User access to this 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.
- Parameters:
- members - the names of members to add to User access
addContributorAccessMembers
void addContributorAccessMembers(java.lang.String[] members)
- Adds each name specified in the string array argument to the members who have Contributor access to this 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.
- Parameters:
- members - the names of members to add to Contributor access
addEditorAccessMembers
void addEditorAccessMembers(java.lang.String[] members)
- Adds each name specified in the string array argument to the members who have Editor access to this 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.
- Parameters:
- members - the names of members to add to Editor access
addManagerAccessMembers
void addManagerAccessMembers(java.lang.String[] members)
- Adds each name specified in the string array argument to the members who have Manager access to this 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.
- Parameters:
- members - the names of members to add to Manager access
removeLiveAccessMembers
void removeLiveAccessMembers(java.lang.String[] members)
- Deprecated. Use removeUserAccessMembers(String[]) instead
- Removes each name specified in the string array argument from the members who have Live access to this 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.
- Parameters:
- members - the names of members to remove from Live access
removeReadAccessMembers
void removeReadAccessMembers(java.lang.String[] members)
- Deprecated. Use removeContributorAccessMembers(String[]) instead
- Removes each name specified in the string array argument from the members who have Read access to this 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.
- Parameters:
- members - the names of members to remove from Read access
removeEditAccessMembers
void removeEditAccessMembers(java.lang.String[] members)
- Deprecated. Use removeEditorAccessMembers(String[]) instead
- Removes each name specified in the string array argument from the members who have Edit access to this 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.
- Parameters:
- members - the names of members to remove from Edit access
removeDeleteAccessMembers
void removeDeleteAccessMembers(java.lang.String[] members)
- Deprecated. Use removeManagerAccessMembers(String[]) instead
- Removes each name specified in the string array argument from the members who have Delete access to this 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.
- Parameters:
- members - the names of members to remove from Delete access
removeUserAccessMembers
void removeUserAccessMembers(java.lang.String[] members)
- Removes each name specified in the string array argument from the members who have User access to this 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.
- Parameters:
- members - the names of members to remove from User access
removeContributorAccessMembers
void removeContributorAccessMembers(java.lang.String[] members)
- Removes each name specified in the string array argument from the members who have Contributor access to this 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.
- Parameters:
- members - the names of members to remove from Contributor access
removeEditorAccessMembers
void removeEditorAccessMembers(java.lang.String[] members)
- Removes each name specified in the string array argument from the members who have Editor access to this 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.
- Parameters:
- members - the names of members to remove from Editor access
removeManagerAccessMembers
void removeManagerAccessMembers(java.lang.String[] members)
- Removes each name specified in the string array argument from the members who have Manager access to this 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.
- Parameters:
- members - the names of members to remove from Manager access
addHistoryLogEntry
void addHistoryLogEntry(java.lang.String message)
- Adds a entry to the History log of this Editable object.
The new History Log Entry will be created using the current API workspace user
- Parameters:
- message - The message to add to the log.
setUserAccessInheritance
void setUserAccessInheritance(boolean inheritUsers)
- Sets if the User access permissions will be inherited from the parent of this Document.
- Parameters:
- inheritUsers - true to set user access permissions to be inherited, or false to block inheritance of permissions from the parent.
setContributorAccessInheritance
void setContributorAccessInheritance(boolean inheritContributors)
- Sets if the Contributor access permissions will be inherited from the parent of this Document.
- Parameters:
- inheritContributors - true to set contributor access permissions to be inherited, or false to block inheritance of permissions from the parent.
setEditorAccessInheritance
void setEditorAccessInheritance(boolean inheritEditors)
- Sets if the Editor access permissions will be inherited from the parent of this Document.
- Parameters:
- inheritEditors - true to set editor access permissions to be inherited, or false to block inheritance of permissions from the parent.
setManagerAccessInheritance
void setManagerAccessInheritance(boolean inheritManagers)
- Sets if the Manager access permissions will be inherited from the parent of this Document.
- Parameters:
- inheritManagers - true to set manager access permissions to be inherited, or false to block inheritance of permissions from the parent.
Overview Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD