Interface PolicyRepositoryService
- All Known Implementing Classes:
PolicyRepositoryServiceImpl
public interface PolicyRepositoryService
-
Method Summary
Modifier and Type Method Description PolicyDefinitionLinkaddPolicyDefinitionLink(java.lang.String policyDefinitionId, java.lang.String type, java.lang.String linkValue)Adds a newPolicyDefinitionLinkfor the given policy definition id.java.lang.StringconvertPolicyDefinitionModelToJson(java.lang.String policyDefinitionId)Returns thePolicyModelas a JSON string.PolicyDeploymentBuildercreateDeployment()Starts creating a new deploymentPolicyDeploymentQuerycreateDeploymentQuery()Query deploymentsPolicyDefinitionQuerycreatePolicyDefinitionQuery()Query case definitionsvoiddeleteDeployment(java.lang.String deploymentId)Deletes the given deployment.voiddeletePolicyDefinitionLink(java.lang.String policyDefinitionLinkId)Deletes anPolicyDefinitionLinkfor the given policy definition link id.java.util.List<java.lang.String>getDeploymentResourceNames(java.lang.String deploymentId)Retrieves a list of deployment resources for the given deployment, ordered alphabetically.PolicyDefinitiongetPolicyDefinition(java.lang.String policyDefinitionId)Returns thePolicyDefinitionincluding all policy information like additional Properties (e.g.PolicyDefinitiongetPolicyDefinitionByKey(java.lang.String policyDefinitionKey)Returns thePolicyDefinitionincluding all policy information like additional Properties (e.g.PolicyDefinitiongetPolicyDefinitionByKeyAndTenantId(java.lang.String policyDefinitionKey, java.lang.String tenantId)Returns thePolicyDefinitionincluding all policy information like additional Properties (e.g.java.util.List<PolicyDefinitionLink>getPolicyDefinitionLinks(java.lang.String policyDefinitionId)ReturnsPolicyDefinitionLinks for the given policy definition id.PolicyModelgetPolicyModel(java.lang.String policyDefinitionId)Returns thePolicyModelincluding all policy model info.PolicyModelgetPolicyModelByKey(java.lang.String policyDefinitionKey)Returns thePolicyModelincluding all policy model info, using the policy definition key and resolving the key to the latest version.PolicyModelgetPolicyModelByKeyAndTenantId(java.lang.String policyDefinitionKey, java.lang.String tenantId)Returns thePolicyModelincluding all policy model info, using the policy definition key and resolving the key to the latest version.java.io.InputStreamgetResourceAsStream(java.lang.String deploymentId, java.lang.String resourceName)Gives access to a deployment resource through a stream of bytes.
-
Method Details
-
createDeployment
PolicyDeploymentBuilder createDeployment()Starts creating a new deployment -
getDeploymentResourceNames
java.util.List<java.lang.String> getDeploymentResourceNames(java.lang.String deploymentId)Retrieves a list of deployment resources for the given deployment, ordered alphabetically.- Parameters:
deploymentId- id of the deployment, cannot be null.
-
getResourceAsStream
java.io.InputStream getResourceAsStream(java.lang.String deploymentId, java.lang.String resourceName)Gives access to a deployment resource through a stream of bytes.- Parameters:
deploymentId- id of the deployment, cannot be null.resourceName- name of the resource, cannot be null.- Throws:
org.flowable.common.engine.api.FlowableObjectNotFoundException- when the resource doesn't exist in the given deployment or when no deployment exists for the given deploymentId.
-
getPolicyModel
Returns thePolicyModelincluding all policy model info. -
getPolicyModelByKey
Returns thePolicyModelincluding all policy model info, using the policy definition key and resolving the key to the latest version. -
getPolicyModelByKeyAndTenantId
PolicyModel getPolicyModelByKeyAndTenantId(java.lang.String policyDefinitionKey, java.lang.String tenantId)Returns thePolicyModelincluding all policy model info, using the policy definition key and resolving the key to the latest version. -
convertPolicyDefinitionModelToJson
java.lang.String convertPolicyDefinitionModelToJson(java.lang.String policyDefinitionId)Returns thePolicyModelas a JSON string. -
getPolicyDefinition
Returns thePolicyDefinitionincluding all policy information like additional Properties (e.g. documentation). -
getPolicyDefinitionByKey
Returns thePolicyDefinitionincluding all policy information like additional Properties (e.g. documentation). The latest version for the given key will be returned. -
getPolicyDefinitionByKeyAndTenantId
PolicyDefinition getPolicyDefinitionByKeyAndTenantId(java.lang.String policyDefinitionKey, java.lang.String tenantId)Returns thePolicyDefinitionincluding all policy information like additional Properties (e.g. documentation). The latest version for the given key will be returned. -
getPolicyDefinitionLinks
ReturnsPolicyDefinitionLinks for the given policy definition id. -
addPolicyDefinitionLink
PolicyDefinitionLink addPolicyDefinitionLink(java.lang.String policyDefinitionId, java.lang.String type, java.lang.String linkValue)Adds a newPolicyDefinitionLinkfor the given policy definition id. -
deletePolicyDefinitionLink
void deletePolicyDefinitionLink(java.lang.String policyDefinitionLinkId)Deletes anPolicyDefinitionLinkfor the given policy definition link id. -
deleteDeployment
void deleteDeployment(java.lang.String deploymentId)Deletes the given deployment.- Parameters:
deploymentId- id of the deployment, cannot be null.
-
createDeploymentQuery
PolicyDeploymentQuery createDeploymentQuery()Query deployments -
createPolicyDefinitionQuery
PolicyDefinitionQuery createPolicyDefinitionQuery()Query case definitions
-