oracle.iam.provisioning.api

Interface ApplicationObjectclassService

public interface ApplicationObjectclassService

Method Summary

Modifier and Type	Method and Description
ApplicationObjectclass	create(ApplicationObjectclass aoc) Creates instance of ApplicationObjectclass.
boolean	delete(java.lang.String applicationObjectclassID) Deletes ApplicationObjectclass instance
java.util.List	findApplicationObjectclass(SearchCriteria searchCriteria, java.util.HashMap configParams) This API method finds the ApplicationObjectclass objects based on SearchCriteria .
ApplicationObjectclass	findApplicationObjectclassByID(java.lang.String applicationObjectclassID) This API method is the convenient way to find ApplicationObjectclass using ApplicationObjectclass Name.
ApplicationObjectclass	findApplicationObjectclassByName(java.lang.String applicationObjectclassName) This API method is the convenient way to find ApplicationObjectclass using ApplicationObjectclass Name.
ApplicationObjectclass	modify(ApplicationObjectclass aoc) Updates existing instance of ApplicationObjectclass.

Method Detail

create

ApplicationObjectclass create(ApplicationObjectclass aoc)
                       throws DuplicateApplicationObjectclassException,
                              AccessDeniedException,
                              GenericAppConfigException

Creates instance of ApplicationObjectclass.

Parameters:

aoc - -ApplicationObjectclass instance

Returns:

created instance of ApplicationObjectclass

Throws:

DuplicateApplicationObjectclassException

AccessDeniedException

GenericAppConfigException

Since:

11.2.3.0.0

modify

ApplicationObjectclass modify(ApplicationObjectclass aoc)
                       throws AppicationObjectclassNotFoundException,
                              AccessDeniedException,
                              GenericAppConfigException

Updates existing instance of ApplicationObjectclass. Note id, targetObjectclass field cannot be updated.

Parameters:

aoc - - ApplicationObjectclass instance to be updated

Returns:

modified instance of ApplicationObjectclass

Throws:

AppicationObjectclassNotFoundException

AccessDeniedException

GenericAppConfigException

Since:

11.2.3.0.0

delete

boolean delete(java.lang.String applicationObjectclassID)
        throws AppicationObjectclassNotFoundException,
               AccessDeniedException,
               GenericAppConfigException

Deletes ApplicationObjectclass instance

Parameters:

applicationObjectclassID - - ID of ApplicationObjectclass to be deleted

Returns:

if applicationObjectclassID is deleted successfully

Throws:

AppicationObjectclassNotFoundException

AccessDeniedException - if there are authorization failures while creating ApplicationObjectclass

GenericAppConfigException

Since:

11.2.3.0.0

findApplicationObjectclassByName

ApplicationObjectclass findApplicationObjectclassByName(java.lang.String applicationObjectclassName)
                                                 throws AppicationObjectclassNotFoundException,
                                                        GenericAppConfigException

This API method is the convenient way to find ApplicationObjectclass using ApplicationObjectclass Name. This API internally will call findApplicationObjectclass API.

Parameters:

applicationObjectclassName - - The ApplicationObjectclass Name

Returns:

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

Throws:

ApplicationObjectclassNotFoundException - thrown if ApplicationObjectclass name does not exist.

GenericAppConfigException - if error occurs while fetching the records in db

AppicationObjectclassNotFoundException

Since:

11.2.3.0.0

findApplicationObjectclassByID

ApplicationObjectclass findApplicationObjectclassByID(java.lang.String applicationObjectclassID)
                                               throws AppicationObjectclassNotFoundException,
                                                      GenericAppConfigException

This API method is the convenient way to find ApplicationObjectclass using ApplicationObjectclass Name. This API internally will call findApplicationObjectclass API.

Parameters:

applicationObjectclassID - - The ApplicationObjectclass ID

Returns:

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

Throws:

ApplicationObjectclassNotFoundException - thrown if ApplicationObjectclass name does not exist.

GenericAppConfigException - if error occurs while fetching the records in db

AppicationObjectclassNotFoundException

Since:

11.1.3.0.0

findApplicationObjectclass

java.util.List findApplicationObjectclass(SearchCriteria searchCriteria,
                                          java.util.HashMap configParams)
                                   throws GenericAppConfigException

This API method finds the ApplicationObjectclass 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 ApplicationObjectclass containing the ID of the ApplicationObjectclass created. If no items found, it will return empty list.

Throws:

GenericAppConfigException - if error occurs while fetching the records in db

Since:

11.2.3.0.0