com.ibm.workplace.wcm.api
Interface EditableLibraryComponent

All Superinterfaces:

Document, LibraryComponent

All Known Subinterfaces:

LibraryDateComponent, LibraryDocumentManagerComponent, LibraryFileComponent, LibraryHTMLComponent, LibraryImageComponent, LibraryLinkComponent, LibraryNumericComponent, LibraryStyleSheetComponent, LibraryUserSelectionComponent

public interface EditableLibraryComponent

extends LibraryComponent

The EditableLibraryComponent interface represents components that can be stored in the repository that are both Editable through this API and a Library Component.

Passing a null argument to a method of this interface will result in a NullPointerException, unless stated otherwise. '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.

note: since v6.0.0, a LibraryComponent is referred to as a "Component" in the Authoring UI.

See Also:

Editable, LibraryComponent

Method Summary

void	addAuthors(java.lang.String[] authors) Adds each name specified in the string array argument to the authors of this EditableLibraryComponent object.
void	addDeleteAccessMembers(java.lang.String[] members) Adds each name specified in the string array argument to the members that have Delete access to this EditableLibraryComponent object.
void	addEditAccessMembers(java.lang.String[] members) Adds each name specified in the string array argument to the members that have Edit access to this EditableLibraryComponent 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 name specified in the string array argument to the owners of this EditableLibraryComponent object.
void	addReadAccessMembers(java.lang.String[] members) Adds each name specified in the string array argument to the members that have Read access to this EditableLibraryComponent 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 EditableLibraryComponent object.
void	removeDeleteAccessMembers(java.lang.String[] members) Removes each name specified in the string array argument from the members that have Delete access to this EditableLibraryComponent object.
void	removeEditAccessMembers(java.lang.String[] members) Removes each name specified in the string array argument from the members that have Edit access to this EditableLibraryComponent 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 EditableLibraryComponent object.
void	removeReadAccessMembers(java.lang.String[] members) Removes each name specified in the string array argument from the members that have Read access to this EditableLibraryComponent object.
void	setDescription(java.lang.String description) Sets the description of this EditableLibraryComponent object to the specified String argument.
void	setName(java.lang.String name) Sets the name of this EditableLibraryComponent object to the specified String argument.
void	setTitle(java.lang.String title) Sets the title of this EditableLibraryComponent 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 EditableLibraryComponent 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 EditableLibraryComponent has changed; false otherwise

setName

public void setName(java.lang.String name)

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

Parameters:

name - the name

setTitle

public void setTitle(java.lang.String title)

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

Parameters:

title - the title

setDescription

public void setDescription(java.lang.String description)

Sets the description of this EditableLibraryComponent object to the specified String argument.

This method accepts a null argument.

Parameters:

description - the description

addAuthors

public void addAuthors(java.lang.String[] authors)

Adds each name specified in the string array argument to the authors of this EditableLibraryComponent object.

An author is only added if the name supplied in the string array argument can be converted to a valid member. Names that cannot be converted to a valid member are skipped and not added.

Note: Each author of this EditableLibraryComponent 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 EditableLibraryComponent object.

An author is only removed if the name supplied in the string array argument can be converted to a valid member and already an author of this EditableLibraryComponent. Names that cannot be converted to a valid member are skipped.

Parameters:

authors - the authors to remove

addOwners

public void addOwners(java.lang.String[] owners)

Adds each name specified in the string array argument to the owners of this EditableLibraryComponent object.

An owner is only added if the name supplied in the string array argument can be converted to a valid member. Names that cannot be converted to a valid member are skipped and not added.

Note: Each owner of this EditableLibraryComponent 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 EditableLibraryComponent object.

An owner is only removed if the name supplied in the string array argument can be converted to a valid member and already an owner of this EditableLibraryComponent. Names that cannot be converted to a valid member are skipped.

Parameters:

owners - the owners 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 that have Live access to this EditableLibraryComponent object.

A name is only added if the name supplied in the string array argument can be converted to a valid member. Names that cannot be converted to a valid member are skipped and not added.

Note: Each owner of this EditableLibraryComponent 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 that have Read access to this EditableLibraryComponent object.

A name is only added if the name supplied in the string array argument can be converted to a valid member. Names that cannot be converted to a valid member are skipped and not added.

Note: Each owner of this EditableLibraryComponent object must be unique. I.e. Duplicates are removed.

Parameters:

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 that have Edit access to this EditableLibraryComponent object.

A name is only added if the name supplied in the string array argument can be converted to a valid member. Names that cannot be converted to a valid member are skipped and not added.

Note: Each owner of this EditableLibraryComponent object must be unique. I.e. Duplicates are removed.

Parameters:

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 that have Delete access to this EditableLibraryComponent object.

A name is only added if the name supplied in the string array argument can be converted to a valid member. Names that cannot be converted to a valid member are skipped and not added.

Note: Each owner of this EditableLibraryComponent object must be unique. I.e. Duplicates are removed.

Parameters:

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 that have Live access to this EditableLibraryComponent object.

An owner is only removed if the name supplied in the string array argument can be converted to a valid member and already has Live access to this EditableLibraryComponent. Names that cannot be converted to a valid member are skipped.

Parameters:

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 that have Read access to this EditableLibraryComponent object.

An owner is only removed if the name supplied in the string array argument can be converted to a valid member and already has Read access to this EditableLibraryComponent. Names that cannot be converted to a valid member are skipped.

Parameters:

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 that have Edit access to this EditableLibraryComponent object.

An owner is only removed if the name supplied in the string array argument can be converted to a valid member and already has Edit access to this EditableLibraryComponent. Names that cannot be converted to a valid member are skipped.

Parameters:

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 that have Delete access to this EditableLibraryComponent object.

An owner is only removed if the name supplied in the string array argument can be converted to a valid member and already has Delete access to this EditableLibraryComponent. Names that cannot be converted to a valid member are skipped.

Parameters:

members - to remove from Delete access.