public interface CentraSiteGroup extends ResourceAccessType
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
GROUP_USER_ASSOC_EXPORT
The association type to be established from a group object to a user during export (e.g. group --> user)
|
Modifier and Type | Method and Description |
---|---|
void |
addOrganization(Organization organization)
Add organization to this group's related organizations.
|
void |
addRoles(java.util.Collection<CentraSiteRole> roles)
Add specified roles to this group.
|
void |
addUsers(java.util.Collection<CentraSiteUser> users)
Adds specified users to this group.
|
java.util.Collection<RegistryObject> |
adjustImported()
Adjust this group after import.
|
java.util.Collection<CentraSiteUser> |
getExternalGroupMembers()
This method is used to get the users from the unsaved external group for displaying in the UI for Import Group Members functionality.
|
java.util.Collection<Organization> |
getOrganizations()
Get all organizations this group is related to.
|
java.util.Collection<CentraSiteRole> |
getRoles()
Returns all the roles assigned to this group.
|
java.util.Collection<CentraSiteUser> |
getUsers()
Get all users of this Group.
|
boolean |
hasFull(com.centrasite.jaxr.infomodel.CentraSiteRegistryObject ro)
Check whether the group has full permission on the given registry object.
|
boolean |
hasModify(com.centrasite.jaxr.infomodel.CentraSiteRegistryObject ro)
Check whether the group has modify permission on the given registry object.
|
boolean |
hasView(com.centrasite.jaxr.infomodel.CentraSiteRegistryObject ro)
Check whether the group has view permission on the given registry object.
|
boolean |
isRegistered()
Check if this group is associated with External Group.
|
boolean |
isSystemDefined()
Check whether this Group is system defined i.e. immutable.
|
boolean |
isUserDefined()
Check whether this Group is user defined i.e. mutable.
|
void |
prepareForExport()
Prepare this group for export e.g. add JAXR associations for all users that are members of the group.
|
void |
register()
Associate this group with an external group.
|
void |
removeOrganization(Organization organization)
Remove single organization from this group's related organizations.
|
void |
removeRoles(java.util.Collection<CentraSiteRole> roles)
Remove specified roles from this group.
|
void |
removeUsers(java.util.Collection<CentraSiteUser> users)
Removes specified users from this group.
|
void |
save()
Persist the group.
|
void |
setSystemDefined(boolean isSystemDefined)
Set whether the Group is system defined and immutable or not.
|
void |
setUserDefined(boolean isUserDefined)
Set whether the Group is user defined and mutable or not.
|
void |
unregister()
Unregister this group.
|
addAssociations, addClassifications, addExternalLinks, addSlots, getAssociations, getClassifications, getDescription, getDisplayName, getExternalLinks, getExternalProperties, getId, getProperties, getSlots, preDelete, preSave, removeAssociations, removeClassifications, removeExternalLinks, removeProperties, removeSlots, setDescription, setDisplayName, setProperties, synchronizeProperties
static final java.lang.String GROUP_USER_ASSOC_EXPORT
void removeOrganization(Organization organization)
organization
- The organization to be removed.void addOrganization(Organization organization) throws JAXRException
organization
- The organization to add.JAXRException
- If a JAXR error occursjava.util.Collection<Organization> getOrganizations() throws JAXRException
Collection
of Organization
instances.JAXRException
- If a JAXR error occursvoid addRoles(java.util.Collection<CentraSiteRole> roles) throws JAXRException, SagGeneralSecurityException
roles
- The Collection
of CentraSiteRole
objects to add to this groupJAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursvoid removeRoles(java.util.Collection<CentraSiteRole> roles) throws JAXRException, SagGeneralSecurityException
roles
- The Collection
of CentraSiteRole
objects to remove from the groupJAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursjava.util.Collection<CentraSiteRole> getRoles() throws JAXRException, SagGeneralSecurityException
Collection
of CentraSiteRole
objects this group has been assigned (may be empty but not null)JAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursjava.util.Collection<CentraSiteUser> getUsers() throws JAXRException, SagGeneralSecurityException
Collection
of CentraSiteUser
objects who are members of this groupJAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursjava.util.Collection<CentraSiteUser> getExternalGroupMembers() throws JAXRException, SagGeneralSecurityException
Collection
of CentraSiteUser
objectsJAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursvoid addUsers(java.util.Collection<CentraSiteUser> users) throws JAXRException, SagGeneralSecurityException
users
- The Collection
of registered CentraSiteUser
objects who should be added as members of this groupJAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursvoid removeUsers(java.util.Collection<CentraSiteUser> users) throws JAXRException, SagGeneralSecurityException
users
- The users to be removed from the groupJAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursboolean isRegistered() throws JAXRException, SagGeneralSecurityException
JAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursvoid register() throws JAXRException, SagGeneralSecurityException
GroupManager.addAssociation(CentraSiteGroup, CentraSiteGroup)
; should be called.JAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursvoid unregister() throws JAXRException, SagGeneralSecurityException
JAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursvoid save() throws JAXRException, SagGeneralSecurityException
JAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursboolean isSystemDefined() throws JAXRException
JAXRException
- If a JAXR error occursvoid setSystemDefined(boolean isSystemDefined)
isSystemDefined
- If true, the group is system defined and if false, it is a user defined group.boolean isUserDefined() throws JAXRException
JAXRException
- If a JAXR error occursvoid setUserDefined(boolean isUserDefined)
isUserDefined
- If false, the group is system defined and if true, it is a user defined group.void prepareForExport() throws JAXRException, SagGeneralSecurityException
JAXRException
- If JAXR error occursSagGeneralSecurityException
- If a security error occursjava.util.Collection<RegistryObject> adjustImported() throws JAXRException, SagGeneralSecurityException
Collection
of modified group objects having their associations removed.JAXRException
- If JAXR error occursSagGeneralSecurityException
- If a security error occursboolean hasView(com.centrasite.jaxr.infomodel.CentraSiteRegistryObject ro) throws JAXRException
ro
- The RegistryObject
for which the check is made to see if the group has permissionJAXRException
- If a JAXR related error occursboolean hasModify(com.centrasite.jaxr.infomodel.CentraSiteRegistryObject ro) throws JAXRException
ro
- The RegistryObject
for which the check is made to see if the group has permissionJAXRException
- If a JAXR related error occursboolean hasFull(com.centrasite.jaxr.infomodel.CentraSiteRegistryObject ro) throws JAXRException
ro
- The RegistryObject
for which the check is made to see if the group has permissionJAXRException
- If a JAXR related error occurs