|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ApprovalPolicyService
Approval policy service is used for managing approval policies and its related operations . This service allows
Below is the code snippet that shows how to get an instance of this service:
//returns an approval policy service instance
ApprovalPolicyService approvalPolicyService = Platform.getService(ApprovalPolicyService.class);
// Create an approval policy.
List<String> templateNames = approvalPolicyService.createApprovalPolicy(anApprovalPolicy);
....
Method Summary | |
---|---|
java.lang.String |
createApprovalPolicy(ApprovalPolicy appPolicy) Create an approval policy |
boolean |
deleteApprovalPolicy(java.util.List appPolicyKeys) Deletes approval policies |
java.util.List |
getApprovalRuleEntity(java.lang.String modelname, java.lang.String policyLevel, boolean isAllScope) Provided a request modelname, it returns a list of entity to construct simple rule |
java.util.List |
getDatasetNames(java.lang.String ApprovalPolicyName) Provided an Approval Policy name, it returns the list of dataset file name corresponding to the request model that policy is associated with |
boolean |
modifyApprovalPolicy(ApprovalPolicy appPolicy) Modify an approval policy |
java.util.List |
search(ApprovalPolicySearchCriteria searchParams) Retrieves the Approval Policy that matches the specified criteria. |
Method Detail |
---|
java.lang.String createApprovalPolicy(ApprovalPolicy appPolicy) throws ApprovalPolicyServiceException
appPolicy
- value object containing policy informationApprovalServiceException
ApprovalPolicyServiceException
boolean modifyApprovalPolicy(ApprovalPolicy appPolicy) throws ApprovalPolicyServiceException, oracle.iam.platform.kernel.StaleDataException
appPolicy
- value object containing policy informationApprovalServiceException
ApprovalPolicyServiceException
oracle.iam.platform.kernel.StaleDataException
boolean deleteApprovalPolicy(java.util.List appPolicyKeys) throws ApprovalPolicyServiceException
List
- of Approval Policy keys to be deletedApprovalServiceException
ApprovalPolicyServiceException
java.util.List search(ApprovalPolicySearchCriteria searchParams) throws ApprovalPolicyServiceException
searchParams
- - search criteria
Below is the list of allowed search parameters
APPROVAL_POLICY_KEY
, - unique key for approval Policy ( for internal use)APPROVAL_POLICY_NAME
, - Name of the Approval PolicyAPPROVAL_POLICY_MODEL_NAME
, - Name of the model associated with the Approval PolicyAPPROVAL_POLICY_LEVEL
, - Level of the Approval PolicyAPPROVAL_POLICY_SCOPE_TYPE
, - Scope type of the Approval PolicyAPPROVAL_POLICY_PROCESS
, - Approval Process associated with the Approval PolicyAPPROVAL_POLICY_PRIORITY
, - Priority of the Approval PolicyApprovalPolicyService approvalPolicyService = Platform.getService(ApprovalPolicyService.class);
List<ApprovalPolicy> approvalPolicies = approvalPolicyService.search(searchCriteria)
ApprovalPolicyServiceException
java.util.List getApprovalRuleEntity(java.lang.String modelname, java.lang.String policyLevel, boolean isAllScope) throws ApprovalPolicyServiceException
modelname
- - Request Model NamepolicyLevel
- - Approval Policy Level i.e. Request Level/Operation LevelisAllScope
- - true if scope type is ALL SCOPEApprovalPolicyServiceException
java.util.List getDatasetNames(java.lang.String ApprovalPolicyName) throws ApprovalPolicyServiceException
ApprovalPolicyName
- - Approval Policy nameApprovalPolicyServiceException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |