oracle.iam.provisioning.api

Interface ApplicationInstanceService

public interface ApplicationInstanceService

ApplicationInstanceService application programming interface provides methods needed to create and manage ApplicationInstance for both connected and disconnected ApplicationInstance.

Since:

11.1.2.0.0

See Also:

ApplicationInstance, Entitlement

Method Summary

Modifier and Type	Method and Description
ApplicationInstance	addApplicationInstance(ApplicationInstance objApplicationInstance) This API method adds a record for ApplicationInstance using value-object ApplicationInstance .
java.util.List	addApplicationInstances(java.util.List ApplicationInstanceList) This API method adds records for ApplicationInstances using multiple value-objects for ApplicationInstance .
void	deleteApplicationInstance(long appInstanceKey) This API method deletes a record for the ApplicationInstance using value-object ApplicationInstance .
void	deleteApplicationInstances(long[] appInstanceKeys) This API method deletes records for ApplicationInstances using multiple value-objects for ApplicationInstance .
java.util.List	findApplicationInstance(SearchCriteria searchCriteria, java.util.HashMap configParams) This API method finds the ApplicationInstance objects based on SearchCriteria .
ApplicationInstance	findApplicationInstanceByKey(long appInstanceKey) This API method is the convenient way to find Application Instance using ApplicationInstance Key.
ApplicationInstance	findApplicationInstanceByKey(long appInstanceKey, OperationContext operationContext) This API method is the convenient way to find Application Instance using ApplicationInstance Key.
ApplicationInstance	findApplicationInstanceByName(java.lang.String appInstanceName) This API method is the convenient way to find Application Instance using ApplicationInstance Name.
java.util.List	findParentApplicationInstance(java.lang.String objectName, SearchCriteria searchCriteria, java.util.HashMap configParams) This API method finds Application Instances that can be set as Parent Application Instance.
ApplicationInstance	updateApplicationInstance(ApplicationInstance objApplicationInstance) This API method modifies a the name of the ApplicationInstance using ApplicationInstance value-object.
java.util.List	updateApplicationInstances(java.util.List ApplicationInstanceList) This API method modifies records for ApplicationInstances using multiple value-objects for ApplicationInstance .

Method Detail

addApplicationInstance

ApplicationInstance addApplicationInstance(ApplicationInstance objApplicationInstance)
                                    throws ITResourceNotFoundException,
                                           ObjectNotFoundException,
                                           DuplicateApplicationInstanceException,
                                           DuplicateApplicationInstanceNameException,
                                           RequestDataSetNotFoundException,
                                           AccessDeniedException,
                                           GenericAppInstanceServiceException

This API method adds a record for ApplicationInstance using value-object ApplicationInstance .

Parameters:

objApplicationInstance - - The ApplicationInstance value object

Returns:

A ApplicationInstance containing the key of the Application Instance created.

Throws:

ITResourceNotFoundException - if ITResource Key present in Application Instance VO does not exist.

ObjectNotFoundException - if a Object Key present in Application Instance VO is not found

DuplicateApplicationInstanceException - if Application Instance is already created for ITResource-Object combination

AccessDeniedException - if there are authorization failures while creating application instance

GenericAppInstanceServiceException - if error occurs while saving the record in db

DuplicateApplicationInstanceNameException

RequestDataSetNotFoundException

Since:

11.1.2.0.0

updateApplicationInstance

ApplicationInstance updateApplicationInstance(ApplicationInstance objApplicationInstance)
                                       throws ApplicationInstanceNotFoundException,
                                              AccessDeniedException,
                                              GenericAppInstanceServiceException

This API method modifies a the name of the ApplicationInstance using ApplicationInstance value-object.

Parameters:

objApplicationInstance - - The ApplicationInstance value object

Returns:

A modified ApplicationInstance containing the key of the Application Instance that is modified.

Throws:

ApplicationInstanceNotFoundException - if ApplicationInstance Key present in Application Instance VO does not exist.

AccessDeniedException - if there are authorization failures while updating application instance

GenericAppInstanceServiceException - if error occurs while saving the record in db

Since:

11.1.2.0.0

deleteApplicationInstance

void deleteApplicationInstance(long appInstanceKey)
                        throws ApplicationInstanceNotFoundException,
                               AccessDeniedException,
                               GenericAppInstanceServiceException

This API method deletes a record for the ApplicationInstance using value-object ApplicationInstance .

Parameters:

appInstanceKey - - The ApplicationInstance Key

Throws:

ApplicationInstanceNotFoundException - if ApplicationInstance Key present in Application Instance VO does not exist.

AccessDeniedException - if there are authorization failures while deleting application instance

GenericAppInstanceServiceException - if error occurs while saving the record in db

Since:

11.1.2.0.0

findApplicationInstance

java.util.List findApplicationInstance(SearchCriteria searchCriteria,
                                       java.util.HashMap configParams)
                                throws GenericAppInstanceServiceException

This API method finds the ApplicationInstance objects based on SearchCriteria .

Parameters:

searchCriteria - The search criteria based on which entries will be retrieved from the backend. The SearchCriteria Operators supported are AND, OR, EQUAL, NOT_EQUAL For additional comparisons like contains the SearchCriteria Operator will be EQUAL with value to be searched will be '**'

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

The ASSIGNED_PARENT_APP_INSTANCE search configuration parameter can be used to find application instances that are assigned as parent application instance.

The FORMDETAILS search configuration parameter indicates weather form data need to be associated with application instance. There are two possible values for this parameter. To exclude the process form details use EXCLUDE and to include the process form details use INCLUDE. This parameter is optional and works as INCLUDE by default.

Returns:

A List of ApplicationInstance containing the key of the Application Instance created. If no items found, it will return empty list.

Throws:

GenericAppInstanceServiceException - if error occurs while fetching the records in db

Since:

11.1.2.0.0

findApplicationInstanceByKey

ApplicationInstance findApplicationInstanceByKey(long appInstanceKey)
                                          throws ApplicationInstanceNotFoundException,
                                                 GenericAppInstanceServiceException

This API method is the convenient way to find Application Instance using ApplicationInstance Key. This API internally will call findApplicationInstance API.

Parameters:

appInstanceKey - - The ApplicationInstance Key

Returns:

ApplicationInstance value object containing all details. It will be null if no record is found.

Throws:

GenericAppInstanceServiceException - if error occurs while fetching the records in db

ApplicationInstanceNotFoundException

Since:

11.1.2.0.0

findApplicationInstanceByKey

ApplicationInstance findApplicationInstanceByKey(long appInstanceKey,
                                                 OperationContext operationContext)
                                          throws ApplicationInstanceNotFoundException,
                                                 GenericAppInstanceServiceException

This API method is the convenient way to find Application Instance using ApplicationInstance Key. This API is used in request context when approver is required to find details of ApplicationInstance. OperationContext passed to this API method lets authorization decides if logged in user has authorization to get details of ApplicationInstance. This API internally will call findApplicationInstance API.

Parameters:

appInstanceKey - - The ApplicationInstance Key

operationContext - the object extracted from requestContext in approval scenario

Returns:

ApplicationInstance value object containing all details. It will be null if no record is found.

Throws:

GenericAppInstanceServiceException - if error occurs while fetching the records in db

ApplicationInstanceNotFoundException

Since:

11.1.2.0.0

findApplicationInstanceByName

ApplicationInstance findApplicationInstanceByName(java.lang.String appInstanceName)
                                           throws ApplicationInstanceNotFoundException,
                                                  GenericAppInstanceServiceException

This API method is the convenient way to find Application Instance using ApplicationInstance Name. This API internally will call findApplicationInstance API.

Parameters:

appInstanceName - - The ApplicationInstance Name

Returns:

pplicationInstance value object containing all details. It will be null if no record is found.

Throws:

ApplicationInstanceNotFoundException - thrown if ApplicationInstance Key present in Application Instance VO does not exist.

GenericAppInstanceServiceException - if error occurs while fetching the records in db

Since:

11.1.2.0.0

addApplicationInstances

java.util.List addApplicationInstances(java.util.List ApplicationInstanceList)
                                throws BulkException

This API method adds records for ApplicationInstances using multiple value-objects for ApplicationInstance .

Parameters:

ApplicationInstanceList - - The list of ApplicationInstance value object

Returns:

A List of newly created Application Instance containing the key of the Application Instance.

Throws:

AccessDeniedException - if there are authorization failures while creating application instance

BulkException - if error occurred while adding the list of ApplicationInstance.

Since:

11.1.2.0.0

deleteApplicationInstances

void deleteApplicationInstances(long[] appInstanceKeys)
                         throws BulkException

This API method deletes records for ApplicationInstances using multiple value-objects for ApplicationInstance .

Parameters:

appInstanceKeys - - The Array containing ApplicationInstance Keys

Throws:

AccessDeniedException - if there are authorization failures while deleting application instance

BulkException - if error occurred while adding the list of ApplicationInstance.

Since:

11.1.2.0.0

updateApplicationInstances

java.util.List updateApplicationInstances(java.util.List ApplicationInstanceList)
                                   throws BulkException

This API method modifies records for ApplicationInstances using multiple value-objects for ApplicationInstance .

Parameters:

ApplicationInstanceList - - The list of ApplicationInstance value object

Returns:

A list of updated Application Instance

Throws:

AccessDeniedException - if there are authorization failures while updating application instance

BulkException - if error occurred while adding the list of ApplicationInstance.

Since:

11.1.2.0.0

findParentApplicationInstance

java.util.List findParentApplicationInstance(java.lang.String objectName,
                                             SearchCriteria searchCriteria,
                                             java.util.HashMap configParams)
                                      throws ObjectNotFoundException,
                                             GenericAppInstanceServiceException

This API method finds Application Instances that can be set as Parent Application Instance. An Application Instance 'A' can be set as parent to Application Instance 'B', if the resource object of 'B' is dependent on resource object of 'A'

Parameters:

objectName - Object Name of the Application Instance for which Parent Application Instance needs to be set

searchCriteria - The search criteria based on which entries will be retrieved from the back end. The SearchCriteria Operators supported are AND, OR, EQUAL, NOT_EQUAL

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

The FORMDETAILS search configuration parameter indicates weather form data need to be associated with application instance. There are two possible values for this parameter. To exclude the process form details use EXCLUDE and to include the process form details use INCLUDE. This parameter is optional and works as INCLUDE by default.

Returns:

A List of ApplicationInstances that can be set as parent.

Throws:

GenericAppInstanceServiceException - if error occurs while fetching the records in db

ObjectNotFoundException - if Object with Object Name passed as parameter does not exist

Since:

11.1.2.0.0