|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ApplicationInstanceService
Method Summary | |
---|---|
ApplicationInstance |
addApplicationInstance(ApplicationInstance objApplicationInstance) Adds a record for ApplicationInstance using value-object ApplicationInstance . |
java.util.List |
addApplicationInstances(java.util.List ApplicationInstanceList) Adds records for ApplicationInstances using multiple value-objects for ApplicationInstance . |
void |
deleteApplicationInstance(long appInstanceKey) Deletes a record for the ApplicationInstance using value-object ApplicationInstance . |
void |
deleteApplicationInstances(long[] appInstanceKeys) Deletes records for ApplicationInstances using multiple value-objects for ApplicationInstance . |
java.util.List |
findApplicationInstance(SearchCriteria searchCriteria, java.util.HashMap configParams) Find the ApplicationInstance objects based on SearchCriteria . |
ApplicationInstance |
findApplicationInstanceByKey(long appInstanceKey) The convenient API to find Application Instance using ApplicationInstance Key. |
ApplicationInstance |
findApplicationInstanceByKey(long appInstanceKey, OperationContext operationContext) The convenient API to find Application Instance using ApplicationInstance Key. |
ApplicationInstance |
findApplicationInstanceByName(java.lang.String appInstanceName) The convenient API to find Application Instance using ApplicationInstance Name. |
java.util.List |
findParentApplicationInstance(java.lang.String objectName, SearchCriteria searchCriteria, java.util.HashMap configParams) Find Application Instances that can be set as Parent Application Instance. |
ApplicationInstance |
updateApplicationInstance(ApplicationInstance objApplicationInstance) Modifies a the name of the ApplicationInstance using value-object ApplicationInstance . |
java.util.List |
updateApplicationInstances(java.util.List ApplicationInstanceList) Modifies records for ApplicationInstances using multiple value-objects for ApplicationInstance . |
Method Detail |
---|
ApplicationInstance addApplicationInstance(ApplicationInstance objApplicationInstance) throws ITResourceNotFoundException, ObjectNotFoundException, DuplicateApplicationInstanceException, DuplicateApplicationInstanceNameException, RequestDataSetNotFoundException, AccessDeniedException, GenericAppInstanceServiceException
objApplicationInstance
- - The ApplicationInstance value objectITResourceNotFoundException
- thrown if ITResource Key present in Application Instance VO does not exist.ObjectNotFoundException
- thrown if a Object Key present in Application Instance VO is not foundDuplicateApplicationInstanceException
- thrown if Application Instance is already created for ITResource-Object combinationAccessDeniedException
- thrown if there are authorization failures while creating application instanceGenericAppInstanceServiceException
- thrown if error occurs while saving the record in dbDuplicateApplicationInstanceNameException
RequestDataSetNotFoundException
ApplicationInstance updateApplicationInstance(ApplicationInstance objApplicationInstance) throws ApplicationInstanceNotFoundException, AccessDeniedException, GenericAppInstanceServiceException
objApplicationInstance
- - The ApplicationInstance value objectApplicationInstanceNotFoundException
- thrown if ApplicationInstance Key present in Application Instance VO does not exist.AccessDeniedException
- thrown if there are authorization failures while updating application instanceGenericAppInstanceServiceException
- thrown if error occurs while saving the record in dbvoid deleteApplicationInstance(long appInstanceKey) throws ApplicationInstanceNotFoundException, AccessDeniedException, GenericAppInstanceServiceException
appInstanceKey
- - The ApplicationInstance KeyApplicationInstanceNotFoundException
- thrown if ApplicationInstance Key present in Application Instance VO does not exist.AccessDeniedException
- thrown if there are authorization failures while deleting application instanceGenericAppInstanceServiceException
- thrown if error occurs while saving the record in dbjava.util.List findApplicationInstance(SearchCriteria searchCriteria, java.util.HashMap configParams) throws GenericAppInstanceServiceException
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 '*<value>*'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.
GenericAppInstanceServiceException
- thrown if error occurs while fetching the records in dbApplicationInstance findApplicationInstanceByKey(long appInstanceKey) throws ApplicationInstanceNotFoundException, GenericAppInstanceServiceException
appInstanceKey
- - The ApplicationInstance KeyoperationContext
- the object extracted from requestContext in approval scenarioGenericAppInstanceServiceException
- thrown if error occurs while fetching the records in dbApplicationInstanceNotFoundException
ApplicationInstance findApplicationInstanceByKey(long appInstanceKey, OperationContext operationContext) throws ApplicationInstanceNotFoundException, GenericAppInstanceServiceException
appInstanceKey
- - The ApplicationInstance KeyGenericAppInstanceServiceException
- thrown if error occurs while fetching the records in dbApplicationInstanceNotFoundException
ApplicationInstance findApplicationInstanceByName(java.lang.String appInstanceName) throws ApplicationInstanceNotFoundException, GenericAppInstanceServiceException
appInstanceName
- - The ApplicationInstance NameApplicationInstanceNotFoundException
- thrown if ApplicationInstance Key present in Application Instance VO does not exist.GenericAppInstanceServiceException
- thrown if error occurs while fetching the records in dbjava.util.List addApplicationInstances(java.util.List ApplicationInstanceList) throws BulkException
ApplicationInstanceList
- - The list of ApplicationInstance value objectAccessDeniedException
- thrown if there are authorization failures while creating application instanceBulkException
- thrown if error occurred while adding the list of ApplicationInstance.void deleteApplicationInstances(long[] appInstanceKeys) throws BulkException
appInstanceKeys
- - The Array containing ApplicationInstance KeysAccessDeniedException
- thrown if there are authorization failures while deleting application instanceBulkException
- thrown if error occurred while adding the list of ApplicationInstance.java.util.List updateApplicationInstances(java.util.List ApplicationInstanceList) throws BulkException
ApplicationInstanceList
- - The list of ApplicationInstance value objectAccessDeniedException
- thrown if there are authorization failures while updating application instanceBulkException
- thrown if error occurred while adding the list of ApplicationInstance.java.util.List findParentApplicationInstance(java.lang.String objectName, SearchCriteria searchCriteria, java.util.HashMap configParams) throws ObjectNotFoundException, GenericAppInstanceServiceException
objectName
- Object Name of the Application Instance for which Parent Application Instance needs to be setsearchCriteria
- The search criteria based on which entries will be retrieved from the back end. The SearchCriteria Operators supported are AND, OR, EQUAL, NOT_EQUALconfigParams
- 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.
GenericAppInstanceServiceException
- thrown if error occurs while fetching the records in dbObjectNotFoundException
- thrown if Object with Object Name passed as parameter does not exist
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |