com.ibm.workplace.wcm.api
Interface LibraryUserSelectionComponent

All Superinterfaces:

Document, EditableLibraryComponent, LibraryComponent

public interface LibraryUserSelectionComponent

extends EditableLibraryComponent

Represents a UserSelection component.

A LibraryUserSelectionComponent is a LibraryComponent and must be stored as a separate entity in the repository.

A LibraryUserSelectionComponent can contain array of java.security.Principal values. This interface provides methods to retrieve and set the array of java.security.Principal Objects contained within this component.

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

See Also:

LibraryComponent

Method Summary

java.security.Principal[]	getSelections() Returns the array of Principals contained in this component as a Principal[].
void	setSelections(java.security.Principal[] selections) Sets the Principal[] contained in this UserSelectionComponent.

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

addAuthors, addDeleteAccessMembers, addEditAccessMembers, addLiveAccessMembers, addOwners, addReadAccessMembers, isChanged, removeAuthors, removeDeleteAccessMembers, removeEditAccessMembers, removeLiveAccessMembers, removeOwners, removeReadAccessMembers, setDescription, setName, setTitle

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

getSelections

public java.security.Principal[] getSelections()

Returns the array of Principals contained in this component as a Principal[].

Returns null if the values is not set.

Returns:

the Principal[]

setSelections

public void setSelections(java.security.Principal[] selections)
                   throws OperationFailedException

Sets the Principal[] contained in this UserSelectionComponent.

Note. This method replaces any existing Principal[] in this component.

Parameters:

selections - the Principal[]

Throws:

OperationFailedException - if the Principal[] argument is null or the selections could not be set