Skip navigation links

oracle.iam.identity.orgmgmt.api
Interface OrganizationManager

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.
void	delete(java.lang.String orgID, boolean isOrgName) 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.
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.
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

create

java.lang.String create(Organization org)
                        throws OrganizationManagerException,
                               AccessDeniedException

Creates a new Organization entity in the backend data store.

Parameters:

org - The Organization value Object containing attributes of the organization to be created.

Returns:

Status of the operation.

Throws:

OrganizationManagerException - If the operation fails.

AccessDeniedException - If the logged-in user does not have the required authorization.

search

java.util.List search(SearchCriteria sc,
                      java.util.Set retAttrs,
                      java.util.Map config)
                      throws OrganizationManagerException,
                             AccessDeniedException

Searches for Organization entities matching the specified SearchCriteria.

Parameters:

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.

Returns:

List of organization entities matching the search criteria.

Throws:

OrganizationManagerException - If operation fails.

AccessDeniedException - If the logged-in user does not have the required authorization.

getDetails

Organization getDetails(java.lang.String orgID,
                        java.util.Set retAttrs,
                        boolean isOrgName)
                        throws OrganizationManagerException,
                               AccessDeniedException

Looks up an already existing Organization entity.

Parameters:

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 returned

isOrgName - Set to true, if the orgID contains Organization name and false if the orgID is Organization key.

Returns:

An Organization entity matching the given orgID.

Throws:

OrganizationManagerException - If operation fails.

AccessDeniedException - If the logged-in user does not have the required authorization.

getDetails

Organization getDetails(java.lang.String attributeName,
                        java.lang.Object attributeValue,
                        java.util.Set retAttrs)
                        throws OrganizationManagerException,
                               AccessDeniedException,
                               SearchKeyNotUniqueException

Looks up an already existing Organization entity.

Parameters:

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 returned

Returns:

An Organization entity matching the given search criteria.

Throws:

OrganizationManagerException - 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.

modify

java.lang.String modify(Organization org)
                        throws OrganizationManagerException,
                               AccessDeniedException

Modifies an already existing Organization entity.

Parameters:

org - The Organization value Object containing attributes and entity id of the Organization to be modified.

Returns:

Status of the operation.

Throws:

OrganizationManagerException - If operation fails.

AccessDeniedException - If the logged-in user does not have the required authorization.

modify

java.lang.String modify(java.lang.String attributeName,
                        java.lang.Object attributeValue,
                        java.util.HashMap attributes)
                        throws OrganizationManagerException,
                               AccessDeniedException,
                               SearchKeyNotUniqueException

Modifies an already existing Organization entity.

Parameters:

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 values

Returns:

Status of the operation.

Throws:

OrganizationManagerException - 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.

delete

void delete(java.lang.String orgID,
            boolean isOrgName)
            throws OrganizationDeleteException,
                   NoSuchOrganizationException,
                   OrganizationAlreadyDeletedException,
                   OrganizationDeleteSubOrgsExistException,
                   OrganizationDeleteSubOrgsUsersExistException,
                   OrganizationDeleteUsersExistException,
                   AccessDeniedException

Deletes an already existing Organization entity. This is a soft delete and doesn't remove the Organization from the data store. It just marks the Organization entity as 'deleted'.

Parameters:

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.

Throws:

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.

delete

void delete(java.lang.String attributeName,
            java.lang.Object attributeValue)
            throws OrganizationDeleteException,
                   NoSuchOrganizationException,
                   OrganizationAlreadyDeletedException,
                   OrganizationDeleteSubOrgsExistException,
                   OrganizationDeleteSubOrgsUsersExistException,
                   OrganizationDeleteUsersExistException,
                   AccessDeniedException,
                   SearchKeyNotUniqueException

Deletes an already existing Organization entity. This is a soft delete and doesn't remove the Organization from the data store. It just marks the Organization entity as 'deleted'.

Parameters:

attributeName - The attribute name for the search criteria.

attributeValue - The attribute value for the search criteria.

Throws:

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.

enable

void enable(java.lang.String orgID,
            boolean isOrgName)
            throws OrganizationEnableException,
                   OrganizationAlreadyDeletedException,
                   NoSuchOrganizationException,
                   AccessDeniedException

Enables an already existing Organization entity.

Parameters:

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.

Throws:

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.

enable

void enable(java.lang.String attributeName,
            java.lang.Object attributeValue)
            throws OrganizationEnableException,
                   OrganizationAlreadyDeletedException,
                   NoSuchOrganizationException,
                   AccessDeniedException,
                   SearchKeyNotUniqueException

Enables an already existing Organization entity.

Parameters:

attributeName - The attribute name for the search criteria.

attributeValue - The attribute value for the search criteria.

Throws:

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.

disable

void disable(java.lang.String orgID,
             boolean isOrgName)
             throws OrganizationDisableException,
                    NoSuchOrganizationException,
                    OrganizationAlreadyDeletedException,
                    OrganizationDisableSubOrgsExistException,
                    OrganizationDisableSubOrgsUsersExistException,
                    OrganizationDisableUsersExistException,
                    AccessDeniedException

Disables an already existing Organization entity.

Parameters:

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.

Throws:

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.

disable

void disable(java.lang.String attributeName,
             java.lang.Object attributeValue)
             throws OrganizationDisableException,
                    NoSuchOrganizationException,
                    OrganizationAlreadyDeletedException,
                    OrganizationDisableSubOrgsExistException,
                    OrganizationDisableSubOrgsUsersExistException,
                    OrganizationDisableUsersExistException,
                    AccessDeniedException,
                    SearchKeyNotUniqueException

Disables an already existing Organization entity.

Parameters:

attributeName - The attribute name for the search criteria.

attributeValue - The attribute value for the search criteria.

Throws:

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.

enable

OrganizationManagerBulkResult enable(java.util.Set orgIDs,
                                     boolean isOrgName)
                                     throws OrganizationStatusChangeException,
                                            NoSuchOrganizationException,
                                            AccessDeniedException

Enables existing Organizations in bulk.

Parameters:

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.

Returns:

OrganizationManagerBulkResult containing operation result for all organizations.

Throws:

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.

disable

OrganizationManagerBulkResult disable(java.util.Set orgIDs,
                                      boolean isOrgName)
                                      throws OrganizationStatusChangeException,
                                             NoSuchOrganizationException,
                                             AccessDeniedException

Disables existing Organizations in bulk.

Parameters:

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.

Returns:

OrganizationManagerBulkResult containing operation result for all Organizations.

Throws:

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.

delete

OrganizationManagerBulkResult delete(java.util.Set orgIDs,
                                     boolean isOrgName)
                                     throws OrganizationStatusChangeException,
                                            NoSuchOrganizationException,
                                            AccessDeniedException

Deletes existing Organizations in bulk. This is a soft delete and doesn't remove the Organizations from the data store. It just marks the Organization entities as 'deleted'.

Parameters:

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.

Returns:

OrganizationManagerBulkResult containing operation result for all Organizations.

Throws:

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.

setUdfInMds

void setUdfInMds()

Skip navigation links