public class PeopleContainer extends PersistentObject
Constructor and Description |
---|
PeopleContainer(CreationTemplate template,
AttrSet attrSet)
Constructs a People Container object without a session.
|
Modifier and Type | Method and Description |
---|---|
void |
addChildPeopleContainer(PeopleContainer pc)
Adds a new People Container object to the People Container.
|
void |
addUser(User user)
Adds a new User object to the People Container.
|
long |
getChildPeopleContainerCount()
Gets the current number of People Containers.
|
long |
getMaxChildPeopleContainerLimit()
Gets the container limit constraint.
|
long |
getMaxUserLimit()
Gets the user limit constraint.
|
String |
getName()
Return name of the People Container.
|
long |
getUserCount()
Gets the current number of users.
|
boolean |
isMember(User user)
Checks if a given user is a member of the container.
|
void |
removeChildPeopleContainer(PeopleContainer pc)
Removes a People Container object from the People Container.
|
void |
removeUser(User user)
Removes an User object from the People Container.
|
void |
setMaxChildPeopleContainerLimit(long limit)
Sets max children People Container limit for a People Container.
|
void |
setMaxUserLimit(long limit)
Sets max user limit for a People Container.
|
addACI, addAttributeValue, addChild, deleteACI, getACI, getACI, getAttribute, getAttribute, getAttributeNames, getAttributes, getAttributes, getAttributes, getChildren, getChildren, getChildren, getGuid, getNamingAttribute, getParentObject, getRoles, isMemberOf, modify, modify, modify, remove, removeAttribute, removeAttributeValue, removeChild, removeChild, rename, replaceACI, save, search, search, search, setAttribute, setAttribute, toString
getParentGuid
public PeopleContainer(CreationTemplate template, AttrSet attrSet) throws UMSException
template
- template for the People Container, containing required and
optional attributes, and possibly default valuesattrSet
- attribute/value setUMSException
public void addUser(User user) throws AccessRightsException, EntryAlreadyExistsException, UMSException
user
- User object to be added to the containerAccessRightsEsception
- if an access rights exception occursEntryAlreadyExistsException
- if the entry already existsUMSException
- Fail to add the objectAccessRightsException
public void addChildPeopleContainer(PeopleContainer pc) throws AccessRightsException, EntryAlreadyExistsException, UMSException
pc
- People Container object to be added to the containerAccessRightsEsception
- if an access rights exception occursEntryAlreadyExistsException
- if the entry already existsUMSException
- fails to add the objectAccessRightsException
public void removeUser(User user) throws AccessRightsException, UMSException
user
- User object to be removed to the containerAccessRightsEsception
- if an access rights exception occursUMSException
- fails to remove the objectAccessRightsException
public void removeChildPeopleContainer(PeopleContainer pc) throws AccessRightsException, EntryNotFoundException, UMSException
pc
- People Container object to be removed to the containerAccessRightsEsception
- if an access rights exception occursEntryNotFoundException
- if the entry is not foundUMSException
- fails to remove the objectAccessRightsException
public long getUserCount() throws UMSException
UMSException
public long getChildPeopleContainerCount() throws UMSException
UMSException
public void setMaxUserLimit(long limit) throws UMSException
limit
- number of users allowed in a People ContainerUMSException
public void setMaxChildPeopleContainerLimit(long limit) throws UMSException
limit
- number of children People Containers allowedUMSException
public long getMaxUserLimit() throws UMSException
UMSException
public long getMaxChildPeopleContainerLimit() throws UMSException
UMSException
public boolean isMember(User user) throws UMSException
user
- User object to be checkedUMSException
public String getName() throws UMSException
UMSException
Copyright © 2010-2014, ForgeRock All Rights Reserved.