public interface Group extends CentraSiteRegistryObject
Modifier and Type | Method and Description |
---|---|
void |
addRoles(java.util.Collection<Role> roles)
Assign the given collection of roles for this group.
|
void |
addUsers(java.util.Collection<User> users)
Add the given collection of users to this group.
|
java.lang.String |
getDisplayName()
Get the display name for the group.
|
java.util.Properties |
getExternalProperties()
Obtain the external properties for this group.
|
java.lang.String |
getId()
Get the unique identifier for the group.
|
java.lang.String |
getOrgDescription()
Get the description of the organization to which this group belongs.
|
java.lang.String |
getOrgName()
Get the name of the organization to which the group belongs.
|
java.util.Collection<Role> |
getRolesOfGroup()
Retrieve the collection of roles assigned to the group.
|
java.util.Collection<User> |
getUsers()
Get the users of this group.
|
boolean |
isRegistered()
Check whether the group is registered with an external repository or not.
|
boolean |
isUserDefined()
Check if the group is user defined or not.
|
void |
removeRoles(java.util.Collection<Role> roles)
Remove the roles for the Group.
|
void |
removeUsers(java.util.Collection<User> users)
Remove the given collection of users from the group.
|
getConsumedAssets, getConsumers, getDescription, getDescription, getDisplayVersion, getInitialVirtualAssetName, getLastModifiedTimeStamp, getLCMAssignment, getLocalName, getMandatoryAttributeProfiles, getName, getName, getNameSpace, getNextVersion, getNextVersions, getOrganization, getOwner, getPendingApprovals, getPreviousVersion, getPreviousVersions, getRegistryObject, getRelationShipValueMap, getRequestedUser, getSubscribers, getSystemVersion, getTitle, getType, getUserVersion, getVisiblePrimaryProfiles, getVisibleProfile, isDeployedOn, isLatestVersionObject, isPropagatePermissions, isPropagateProfilePermissions, removeConsumedAssets, removeConsumers, setDescription, setDescription, setDisplayVersion, setLCMState, setLocalName, setName, setName, setNameSpace, setOrganization, setOwner, setPropagatePermissions, setPropagateProfilePermissions, setRelationShipValueMap, setUserVersion
delete, getAttributeLink, getAttributeValue, getAttributeValue, getAttributeValue, isModified, isPredefined, isReadOnly, save, setAttributeValue, setAttributeValue, setAttributeValue
java.lang.String getId() throws CLLException
getId
in interface CentraSiteObject
CLLException
- If an error occurs while trying to fetch the group propertyjava.util.Properties getExternalProperties() throws CLLException
Properties
CLLException
- If an error occurs while trying to fetch the group's propertiesjava.util.Collection<User> getUsers() throws CLLException
Collection
of User
s assigned to this groupCLLException
- If an error occurs while trying to fetch the group usersvoid addUsers(java.util.Collection<User> users) throws CLLException
users
- The Collection
of User
s to add to the groupCLLException
- If an error occurs while trying to add users to a groupvoid removeUsers(java.util.Collection<User> users) throws CLLException
users
- The Collection
of User
s to remove from the groupCLLException
- If an error occurs while trying to remove the group's usersjava.lang.String getDisplayName() throws CLLException
CLLException
- If an error occurs while trying to fetch the group propertyjava.lang.String getOrgName() throws CLLException
CLLException
- If an error occurs while trying to fetch the group propertyjava.lang.String getOrgDescription() throws CLLException
CLLException
- If an error occurs while trying to fetch the group propertyvoid addRoles(java.util.Collection<Role> roles) throws CLLException
roles
- The Collection
of Role
s to assign to this groupCLLException
- If an error occurs while trying to assign roles to the groupvoid removeRoles(java.util.Collection<Role> roles) throws CLLException
roles
- The Role
s to be removed for the GroupCLLException
- Thrown if Session owner does not have permissions to remove roles from the group or if there are
dependencies/associations between the group and the role.java.util.Collection<Role> getRolesOfGroup() throws CLLException
Collection
of Role
s assigned to this groupCLLException
- When an error is encountered while trying to retrieve the roles of a groupboolean isUserDefined() throws CLLException
CLLException
- If an error occurs while checking the propertyboolean isRegistered() throws CLLException
CLLException
- If an error occurs while checking the property