com.ibm.workplace.wcm.api
Interface UserSelectionComponent

All Superinterfaces:

ContentComponent

public interface UserSelectionComponent

extends ContentComponent

Represents a UserSelection component.

A UserSelectionComponent is a ContentComponent and cannot be stored as a separate entity in the repository.

A UserSelectionComponent can contain array of Principals. This interface provides methods to retrieve and set the array of Principals contained within this component.

note: since v6.0.0, a ContentComponent is referred to as an "Element" in the Authoring UI.

See Also:

ContentComponent

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

getContainer, getName

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