|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface OrganizationManager
The OrganizationManager
API exposes the methods to manage an Organization. To manage an Organization, it provides functionality to create, modify, enable, disable and delete the Organization. It also provides the support for bulk enable, disable and delete Organization operations.
Method Summary | |
---|---|
java.lang.String |
create(Organization org) Creates a new Organization entity in the backend data store. |
OrganizationManagerBulkResult |
delete(java.util.Set orgIDs, boolean isOrgName) Deletes existing Organizations in bulk. |
OrganizationManagerBulkResult |
delete(java.util.Set orgIDs, java.util.Map controlParams) Deletes existing Organizations in bulk. |
void |
delete(java.lang.String orgID, boolean isOrgName) Deletes an already existing Organization entity. |
void |
delete(java.lang.String orgID, java.util.Map controlParams) Deletes an already existing Organization entity. |
void |
delete(java.lang.String attributeName, java.lang.Object attributeValue) Deletes an already existing Organization entity. |
OrganizationManagerBulkResult |
disable(java.util.Set orgIDs, boolean isOrgName) Disables existing Organizations in bulk. |
void |
disable(java.lang.String orgID, boolean isOrgName) Disables an already existing Organization entity. |
void |
disable(java.lang.String attributeName, java.lang.Object attributeValue) Disables an already existing Organization entity. |
OrganizationManagerBulkResult |
enable(java.util.Set orgIDs, boolean isOrgName) Enables existing Organizations in bulk. |
void |
enable(java.lang.String orgID, boolean isOrgName) Enables an already existing Organization entity. |
void |
enable(java.lang.String attributeName, java.lang.Object attributeValue) Enables an already existing Organization entity. |
java.util.List |
getChildOrganizations(java.lang.String orgKey, java.util.Set retAttrs, java.util.Map configParams) Returns list of children of the Organization identified by orgKey. |
Organization |
getDetails(java.lang.String attributeName, java.lang.Object attributeValue, java.util.Set retAttrs) Looks up an already existing Organization entity. |
Organization |
getDetails(java.lang.String orgID, java.util.Set retAttrs, boolean isOrgName) Looks up an already existing Organization entity. |
Organization |
getDetails(java.lang.String orgID, java.util.Set retAttrs, boolean isOrgName, OperationContext opContext) Looks up an already existing Organization entity. |
java.util.List |
getOrganizationMembersRelations(java.lang.String orgKey, java.util.Set retAttrs, SearchCriteria sc, java.util.Map configParams) Returns the User-Org memberships along with the relationship details. |
boolean |
hasStaticUserMembers(java.lang.String orgKey) Checks whether an organization (identified by orgKey) contains any static user members. |
java.lang.String |
modify(Organization org) Modifies an already existing Organization entity. |
java.lang.String |
modify(java.lang.String attributeName, java.lang.Object attributeValue, java.util.HashMap attributes) Modifies an already existing Organization entity. |
java.util.List |
search(SearchCriteria sc, java.util.Set retAttrs, java.util.Map config) Searches for Organization entities matching the specified SearchCriteria. |
void |
setUdfInMds() |
Method Detail |
---|
java.lang.String create(Organization org) throws OrganizationManagerException, AccessDeniedException
org
- The Organization value Object containing attributes of the organization to be created.OrganizationManagerException
- If the operation fails.AccessDeniedException
- If the logged-in user does not have the required authorization.java.util.List search(SearchCriteria sc, java.util.Set retAttrs, java.util.Map config) throws OrganizationManagerException, AccessDeniedException
sc
- The search criteria based on which entries will be retrieved from the backend.retAttrs
- The list of attributes which are to be returned for each Organization.config
- Parameters to further configure the search operation. There are four configuration parameters. STARTROW, ENDROW, SORTEDBY and SORTORDER.
The STARTROW and ENDROW search configuration parameters indicates which subset of the complete search result is to be fetched. These parameters are mandatory.
The SORTEDBY search configuration parameter indicates the attribute on which search result is to be sorted. This parameter is optional and is set to 'User Login' by default.
The SORTORDER search configuration parameter indicates the order of sorting. There are two possible values for this parameter. To sort the result in ascending order use SortOrder.ASCENDING and to sort the result in descending order use SortOrder.DESCENDING. This parameter is optional and is set to SortOrder.ASCENDING by default.
OrganizationManagerException
- If operation fails.AccessDeniedException
- If the logged-in user does not have the required authorization.Organization getDetails(java.lang.String orgID, java.util.Set retAttrs, boolean isOrgName) throws OrganizationManagerException, AccessDeniedException
orgID
- The id of the Organization entity to be looked up. The isOrgName flag determines what does orgID represent.retAttrs
- The list of attributes of the Organization to be returnedisOrgName
- Set to true, if the orgID contains Organization name and false if the orgID is Organization key.orgID
.OrganizationManagerException
- If operation fails.AccessDeniedException
- If the logged-in user does not have the required authorization.Organization getDetails(java.lang.String orgID, java.util.Set retAttrs, boolean isOrgName, OperationContext opContext) throws OrganizationManagerException, AccessDeniedException
orgID
- The id of the Organization entity to be looked up. The isOrgName flag determines what does orgID represent.retAttrs
- The list of attributes of the Organization to be returnedisOrgName
- Set to true, if the orgID contains Organization name and false if the orgID is Organization key.opContext
- Context of a request.orgID
.OrganizationManagerException
- If operation fails.AccessDeniedException
- If the logged-in user does not have the required authorization.Organization getDetails(java.lang.String attributeName, java.lang.Object attributeValue, java.util.Set retAttrs) throws OrganizationManagerException, AccessDeniedException, SearchKeyNotUniqueException
attributeName
- The attribute name for the search criteria.attributeValue
- The attribute value for the search criteria.retAttrs
- The list of attributes of the Organization to be returnedOrganizationManagerException
- If operation fails.AccessDeniedException
- If the logged-in user does not have the required authorization.SearchKeyNotUniqueException
- If more than one Organization for attributeName
and attributeValue
were found.java.lang.String modify(Organization org) throws OrganizationManagerException, AccessDeniedException
org
- The Organization value Object containing attributes and entity id of the Organization to be modified.OrganizationManagerException
- If operation fails.AccessDeniedException
- If the logged-in user does not have the required authorization.java.lang.String modify(java.lang.String attributeName, java.lang.Object attributeValue, java.util.HashMap attributes) throws OrganizationManagerException, AccessDeniedException, SearchKeyNotUniqueException
attributeName
- The attribute name for the search criteria.attributeValue
- The attribute value for the search criteria.attributes
- The attributes of the Organization to modify along with their new valuesOrganizationManagerException
- If operation fails.AccessDeniedException
- If the logged-in user does not have the required authorization.SearchKeyNotUniqueException
- If more than one Organization for attributeName
and attributeValue
were found.void delete(java.lang.String orgID, boolean isOrgName) throws OrganizationDeleteException, NoSuchOrganizationException, OrganizationAlreadyDeletedException, OrganizationDeleteSubOrgsExistException, OrganizationDeleteSubOrgsUsersExistException, OrganizationDeleteUsersExistException, OrganizationOrphanedPublishedEntitiesException, AccessDeniedException
orgID
- The id of the Organization entity to be deleted. The isOrgName flag determines what does orgID represent.isOrgName
- Set to true, if the orgID contains Organization name and false if the orgID is Organization key.NoSuchOrganizationException
- If the Organization with key orgID
does not exist.OrganizationAlreadyDeletedException
- If the Organization entity is already deleted.OrganizationDeleteSubOrgsExistException
- If the Organization has child Organizations which are not yet deleted.OrganizationDeleteSubOrgsUsersExistException
- If the Organization has child Organization whose users are not yet deleted.OrganizationDeleteUsersExistException
- If the organization has users which are not yet deleted.AccessDeniedException
- If the logged-in user does not have the required authorization.OrganizationDeleteException
- If operation fails due to some internal reason.OrganizationOrphanedPublishedEntitiesException
- If published entities will be orphaned.void delete(java.lang.String attributeName, java.lang.Object attributeValue) throws OrganizationDeleteException, NoSuchOrganizationException, OrganizationAlreadyDeletedException, OrganizationDeleteSubOrgsExistException, OrganizationDeleteSubOrgsUsersExistException, OrganizationDeleteUsersExistException, AccessDeniedException, OrganizationOrphanedPublishedEntitiesException, SearchKeyNotUniqueException
attributeName
- The attribute name for the search criteria.attributeValue
- The attribute value for the search criteria.NoSuchOrganizationException
- If the Organization with attribute name attributeName
and value attributeValue
does not exist.OrganizationAlreadyDeletedException
- If the Organization entity is already deleted.OrganizationDeleteSubOrgsExistException
- If the Organization has child Organizations which are not yet deleted.OrganizationDeleteSubOrgsUsersExistException
- If the Organization has child Organization whose users are not yet deleted.OrganizationDeleteUsersExistException
- If the Organization has users which are not yet deleted.AccessDeniedException
- If the logged-in user does not have the required authorization.OrganizationDeleteException
- If operation fails due to some internal reason.SearchKeyNotUniqueException
- If more than one Organization for attributeName
and attributeValue
were found.OrganizationOrphanedPublishedEntitiesException
- If published entities will be orphaned.void delete(java.lang.String orgID, java.util.Map controlParams) throws OrganizationDeleteException, NoSuchOrganizationException, OrganizationAlreadyDeletedException, OrganizationDeleteSubOrgsExistException, OrganizationDeleteSubOrgsUsersExistException, OrganizationDeleteUsersExistException, OrganizationOrphanedPublishedEntitiesException, AccessDeniedException
orgID
- The id of the Organization entity to be deleted.controlParams
- Parameters to control the method logic. Currently may contain the following: If 'isOrgName' flag is set to true, the orgID argument contains Organization name and false if the orgID is Organization key. 'ignoreOrphanedPublishedEntities' flag is set to true if org should be deleted even if deletion will result in orphaned published entities and false if an exception should be thrown if there are orphanable published entities.NoSuchOrganizationException
- If the Organization with key orgID
does not exist.OrganizationAlreadyDeletedException
- If the Organization entity is already deleted.OrganizationDeleteSubOrgsExistException
- If the Organization has child Organizations which are not yet deleted.OrganizationDeleteSubOrgsUsersExistException
- If the Organization has child Organization whose users are not yet deleted.OrganizationDeleteUsersExistException
- If the organization has users which are not yet deleted.AccessDeniedException
- If the logged-in user does not have the required authorization.OrganizationDeleteException
- If operation fails due to some internal reason.OrganizationOrphanedPublishedEntitiesException
- If published entities will be orphaned and ignoreOrphanedPublishedEntities is set to false;void enable(java.lang.String orgID, boolean isOrgName) throws OrganizationEnableException, OrganizationAlreadyDeletedException, NoSuchOrganizationException, AccessDeniedException
orgID
- The id of the Organization entity to be enabled. The isOrgName flag determines what does orgID represent.isOrgName
- Set to true, if the orgID contains Organization name and false if the orgID is Organization key.OrganizationAlreadyDeletedException
- If the Organization entity is in deleted state.NoSuchOrganizationException
- If the Organization with key orgID
does not exist.AccessDeniedException
- If the logged-in user does not have the required authorization.OrganizationEnableException
- If operation fails due to some internal reason.void enable(java.lang.String attributeName, java.lang.Object attributeValue) throws OrganizationEnableException, OrganizationAlreadyDeletedException, NoSuchOrganizationException, AccessDeniedException, SearchKeyNotUniqueException
attributeName
- The attribute name for the search criteria.attributeValue
- The attribute value for the search criteria.OrganizationAlreadyDeletedException
- If the Organization entity is in deleted state.NoSuchOrganizationException
- If the Organization with attribute name attributeName
and value attributeValue
does not exist.AccessDeniedException
- If the logged-in user does not have the required authorization.OrganizationEnableException
- If operation fails due to some internal reason.SearchKeyNotUniqueException
- If more than one Organization for attributeName
and attributeValue
were found.void disable(java.lang.String orgID, boolean isOrgName) throws OrganizationDisableException, NoSuchOrganizationException, OrganizationAlreadyDeletedException, OrganizationDisableSubOrgsExistException, OrganizationDisableSubOrgsUsersExistException, OrganizationDisableUsersExistException, AccessDeniedException
orgID
- The id of the Organization entity to be disabled. The isOrgName flag determines what does orgID represent.isOrgName
- Set to true, if the orgID contains Organization name and false if the orgID is Organization key.NoSuchOrganizationException
- If the Organization with key orgID
does not exist.OrganizationAlreadyDeletedException
- If the Organization entity is in deleted state.OrganizationDisableSubOrgsExistException
- If the Organization has one or more child Organizations and atleast one child Organization in enabled state.OrganizationDisableSubOrgsUsersExistException
- If the Organization has one or more child Organizations and atleast one user of any of the child Organization is enabled.OrganizationDisableUsersExistException
- If the Organization has atleast one user enabled.OrganizationDisableException
- If operation fails due to some internal reason.AccessDeniedException
- If the logged-in user does not have the required authorization.void disable(java.lang.String attributeName, java.lang.Object attributeValue) throws OrganizationDisableException, NoSuchOrganizationException, OrganizationAlreadyDeletedException, OrganizationDisableSubOrgsExistException, OrganizationDisableSubOrgsUsersExistException, OrganizationDisableUsersExistException, AccessDeniedException, SearchKeyNotUniqueException
attributeName
- The attribute name for the search criteria.attributeValue
- The attribute value for the search criteria.NoSuchOrganizationException
- If the Organization with attribute name attributeName
and value attributeValue
does not exist.OrganizationAlreadyDeletedException
- If the Organization entity is in deleted state.OrganizationDisableSubOrgsExistException
- If the Organization has one or more child Organizations and atleast one child Organization in enabled state.OrganizationDisableSubOrgsUsersExistException
- If the Organization has one or more child Organizations and atleast one user of any of the child Organization is enabled.OrganizationDisableUsersExistException
- If the Organization has atleast one user enabled.OrganizationDisableException
- If operation fails due to some internal reason.AccessDeniedException
- If the logged-in user does not have the required authorization.SearchKeyNotUniqueException
- If more than one Organization for attributeName
and attributeValue
were found.OrganizationManagerBulkResult enable(java.util.Set orgIDs, boolean isOrgName) throws OrganizationStatusChangeException, NoSuchOrganizationException, AccessDeniedException
orgIDs
- The ids of the Organizations to be enabled. The isOrgName flag determines what does orgID represent.isOrgName
- Set to true, if orgIDs
contains Organization names and false if the orgIDs
are Organization keys.OrganizationStatusChangeException
- If the Organizations can not be enabled due to some internal reason.NoSuchOrganizationException
- If atleast one of the Organization specified in the orgIDs
list does not exist.AccessDeniedException
- If the logged-in user does not have the required authorization.OrganizationManagerBulkResult disable(java.util.Set orgIDs, boolean isOrgName) throws OrganizationStatusChangeException, NoSuchOrganizationException, AccessDeniedException
orgIDs
- The ids of the Organizations to be disabled. The isOrgName flag determines what does orgID represent.isOrgName
- Set to true, if orgIDs
contains Organization names and false if the orgIDs
are Organization keys.OrganizationStatusChangeException
- If the Organizations can not be disabled due to some internal reason.NoSuchOrganizationException
- If atleast one of the Organization specified in the orgIDs
list does not exist.AccessDeniedException
- If the logged-in user does not have the required authorization.OrganizationManagerBulkResult delete(java.util.Set orgIDs, boolean isOrgName) throws OrganizationStatusChangeException, NoSuchOrganizationException, AccessDeniedException
orgIDs
- The ids of the Organizations to be deleted. The isOrgName flag determines what does orgID represent.isOrgName
- Set to true, if orgIDs
contains Organization names and false if the orgIDs
are Organization keys.OrganizationStatusChangeException
- If the Organizations can not be deleted due to some internal reason.NoSuchOrganizationException
- If atleast one of the Organization specified in the orgIDs
list does not exist.AccessDeniedException
- If the logged-in user does not have the required authorization.OrganizationManagerBulkResult delete(java.util.Set orgIDs, java.util.Map controlParams) throws OrganizationStatusChangeException, NoSuchOrganizationException, AccessDeniedException
orgIDs
- The ids of the Organizations to be deleted.controlParams
- Parameters to control the method logic. Currently may contain the following: If 'isOrgName' flag is set to true, if the orgID contains Organization name and false if the orgID is Organization key. If 'ignoreOrphanedPublishedEntities' flag is set to true if org should be deleted even if deletion will result in orphaned published entities and false if an exception should be thrown if there are orphaned published entities.OrganizationStatusChangeException
- If the Organizations can not be deleted due to some internal reason.NoSuchOrganizationException
- If atleast one of the Organization specified in the orgIDs
list does not exist.AccessDeniedException
- If the logged-in user does not have the required authorization.boolean hasStaticUserMembers(java.lang.String orgKey) throws OrganizationManagerException
orgKey
- The Entity ID of the organizationOrganizationManagerException
java.util.List getChildOrganizations(java.lang.String orgKey, java.util.Set retAttrs, java.util.Map configParams) throws OrganizationManagerException, AccessDeniedException
orgKey
- The parent organization key.retAttrs
- Names of Organization attributes to be returned.configParams
- Sorting and paging parameters.OrganizationManagerException
AccessDeniedException
void setUdfInMds()
java.util.List getOrganizationMembersRelations(java.lang.String orgKey, java.util.Set retAttrs, SearchCriteria sc, java.util.Map configParams) throws OrganizationManagerException, AccessDeniedException
orgKey
- - The id of the OrganizationretAttrs
- - Names of User attributes to be returnedsc
- - SearchCriteria to filter out specific members onlyconfigParams
- - Sorting and pagination parameters. Usage similar to configParams in OrganizationManager.search() method.OrganizationManagerException
AccessDeniedException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |