com.ibm.workplace.wcm.api
Interface LibraryUserSelectionComponent
- All Superinterfaces:
- Document, Editable, EditableLibraryComponent, LibraryComponent, WorkflowedDocument
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.Document |
getAuthors, getContributorAccessMembers, getCreationDate, getDeleteAccessMembers, getDescription, getEditAccessMembers, getEditorAccessMembers, getHistoryLog, getId, getInheritedContributorAccessMembers, getInheritedEditorAccessMembers, getInheritedManagerAccessMembers, getInheritedUserAccessMembers, getLiveAccessMembers, getManagerAccessMembers, getModifiedDate, getName, getOwnerLibrary, getOwners, getReadAccessMembers, getSourceWorkspace, getTitle, getUserAccessMembers, hasDeleteAccess, hasDeleteAccess, hasEditAccess, hasEditAccess, hasLiveAccess, hasLiveAccess, hasReadAccess, hasReadAccess, isContributorAccessInherited, isEditorAccessInherited, isManagerAccessInherited, isUserAccessInherited, isWorkflowed |
Methods inherited from interface com.ibm.workplace.wcm.api.Editable |
addAuthors, addContributorAccessMembers, addDeleteAccessMembers, addEditAccessMembers, addEditorAccessMembers, addHistoryLogEntry, addLiveAccessMembers, addManagerAccessMembers, addOwners, addReadAccessMembers, addUserAccessMembers, isChanged, removeAuthors, removeContributorAccessMembers, removeDeleteAccessMembers, removeEditAccessMembers, removeEditorAccessMembers, removeLiveAccessMembers, removeManagerAccessMembers, removeOwners, removeReadAccessMembers, removeUserAccessMembers, setContributorAccessInheritance, setDescription, setEditorAccessInheritance, setManagerAccessInheritance, setName, setTitle, setUserAccessInheritance |
Methods inherited from interface com.ibm.workplace.wcm.api.Document |
getAuthors, getContributorAccessMembers, getCreationDate, getDeleteAccessMembers, getDescription, getEditAccessMembers, getEditorAccessMembers, getHistoryLog, getId, getInheritedContributorAccessMembers, getInheritedEditorAccessMembers, getInheritedManagerAccessMembers, getInheritedUserAccessMembers, getLiveAccessMembers, getManagerAccessMembers, getModifiedDate, getName, getOwnerLibrary, getOwners, getReadAccessMembers, getSourceWorkspace, getTitle, getUserAccessMembers, hasDeleteAccess, hasDeleteAccess, hasEditAccess, hasEditAccess, hasLiveAccess, hasLiveAccess, hasReadAccess, hasReadAccess, isContributorAccessInherited, isEditorAccessInherited, isManagerAccessInherited, isUserAccessInherited, isWorkflowed |
Methods inherited from interface com.ibm.workplace.wcm.api.WorkflowedDocument |
addAdditionalViewers, addApprovers, cancelDraftDocument, createDraftDocument, decline, getAdditionalViewers, getCurrentApprovers, getEffectiveDate, getExpiryDate, getGeneralDateOne, getGeneralDateTwo, getWorkflowId, getWorkflowStageId, hasApproverAccess, hasApproverAccess, hasDraft, isDraft, isExpired, isPublished, nextWorkflowStage, nextWorkflowStage, removeAdditionalViewers, removeApprovers, restartWorkflow, setEffectiveDate, setExpiryDate, setGeneralDateOne, setGeneralDateTwo, setWorkflowId, setWorkflowId |
getSelections
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
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