com.ibm.workplace.wcm.api
Interface Editable

All Superinterfaces:

Document

All Known Subinterfaces:

Category, Content, ContentComponentContainer, 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. '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

void	addAuthors(java.lang.String[] authors) Adds each author specified in the string array argument to the authors of this Editable object.
void	addDeleteAccessMembers(java.lang.String[] members) Adds each name specified in the string array argument to the members who have Delete access to this Editable object.
void	addEditAccessMembers(java.lang.String[] members) Adds each name specified in the string array argument to the members who have Edit 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. This method is deprecated from version 6.0. Calls to 'Live' access methods have the same effect as 'Read' access method calls.
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) Adds each name specified in the string array argument to the members who have Read 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	removeDeleteAccessMembers(java.lang.String[] members) Removes each name specified in the string array argument from the members who have Delete access to this Editable object.
void	removeEditAccessMembers(java.lang.String[] members) Removes each name specified in the string array argument from the members who have Edit access to this Editable object.
void	removeLiveAccessMembers(java.lang.String[] members) Deprecated. This method is deprecated from version 6.0. Calls to 'Live' access methods have the same effect as 'Read' access method calls.
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) Removes each name specified in the string array argument from the members who have Read access to this Editable object.
void	setDescription(java.lang.String description) Sets the description of this Editable object to the specified String argument.
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.

Methods inherited from interface com.ibm.workplace.wcm.api.Document

getAuthors, getDeleteAccessMembers, getDescription, getEditAccessMembers, getHistoryLog, getId, getLiveAccessMembers, getModifiedDate, getName, getOwnerLibrary, getOwners, getReadAccessMembers, getTitle, hasDeleteAccess, hasDeleteAccess, hasEditAccess, hasEditAccess, hasLiveAccess, hasLiveAccess, hasReadAccess, hasReadAccess

Method Detail

isChanged

public 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

public void setName(java.lang.String name)

Sets the name of this Editable object to the specified String argument.

Parameters:

name - of the editable

setTitle

public void setTitle(java.lang.String title)

Sets the title of this Editable object to the specified String argument.

Parameters:

title - of the editable

setDescription

public 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

public 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

public 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

public 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

public 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

public void addLiveAccessMembers(java.lang.String[] members)

Deprecated. This method is deprecated from version 6.0. Calls to 'Live' access methods have the same effect as 'Read' access method calls.

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

public void addReadAccessMembers(java.lang.String[] members)

Adds each name specified in the string array argument to the members who have Read access to this Editable object.

If the object is workflowed, only the administrator can successfully add the names. Other users will not receive an error, but members in the list would not be granted Read access.

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

public void addEditAccessMembers(java.lang.String[] members)

Adds each name specified in the string array argument to the members who have Edit access to this Editable object.

If the object is workflowed, only the administrator can successfully add the names. Other users will not receive an error, but members in the list would not be granted Edit access.

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

public void addDeleteAccessMembers(java.lang.String[] members)

Adds each name specified in the string array argument to the members who have Delete access to this Editable object.

If the object is workflowed, only the administrator can successfully add the names. Other users will not receive an error, but members in the list would not be granted Delete access.

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

removeLiveAccessMembers

public void removeLiveAccessMembers(java.lang.String[] members)

Deprecated. This method is deprecated from version 6.0. Calls to 'Live' access methods have the same effect as 'Read' access method calls.

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

public void removeReadAccessMembers(java.lang.String[] members)

Removes each name specified in the string array argument from the members who have Read access to this Editable object.

If the object is workflowed, only the administrator can successfully add the names. Other users will not receive an error, but Read access would not be revoked from members in the list.

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

public void removeEditAccessMembers(java.lang.String[] members)

Removes each name specified in the string array argument from the members who have Edit access to this Editable object.

If the object is workflowed, only the administrator can successfully add the names. Other users will not receive an error, but Edit access would not be revoked from members in the list.

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

public void removeDeleteAccessMembers(java.lang.String[] members)

Removes each name specified in the string array argument from the members who have Delete access to this Editable object.

If the object is workflowed, only the administrator can successfully add the names. Other users will not receive an error, but Delete access would not be revoked from members in the list.

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

addHistoryLogEntry

public 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.