Interface PolicyRepositoryService
- All Known Implementing Classes:
PolicyRepositoryServiceImpl
public interface PolicyRepositoryService
-
Method Summary
Modifier and Type Method Description PolicyDefinitionLink
addPolicyDefinitionLink(java.lang.String policyDefinitionId, java.lang.String type, java.lang.String linkValue)
Adds a newPolicyDefinitionLink
for the given policy definition id.java.lang.String
convertPolicyDefinitionModelToJson(java.lang.String policyDefinitionId)
Returns thePolicyModel
as a JSON string.PolicyDeploymentBuilder
createDeployment()
Starts creating a new deploymentPolicyDeploymentQuery
createDeploymentQuery()
Query deploymentsPolicyDefinitionQuery
createPolicyDefinitionQuery()
Query case definitionsvoid
deleteDeployment(java.lang.String deploymentId)
Deletes the given deployment.void
deletePolicyDefinitionLink(java.lang.String policyDefinitionLinkId)
Deletes anPolicyDefinitionLink
for 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.PolicyDefinition
getPolicyDefinition(java.lang.String policyDefinitionId)
Returns thePolicyDefinition
including all policy information like additional Properties (e.g.PolicyDefinition
getPolicyDefinitionByKey(java.lang.String policyDefinitionKey)
Returns thePolicyDefinition
including all policy information like additional Properties (e.g.PolicyDefinition
getPolicyDefinitionByKeyAndTenantId(java.lang.String policyDefinitionKey, java.lang.String tenantId)
Returns thePolicyDefinition
including all policy information like additional Properties (e.g.java.util.List<PolicyDefinitionLink>
getPolicyDefinitionLinks(java.lang.String policyDefinitionId)
ReturnsPolicyDefinitionLink
s for the given policy definition id.PolicyModel
getPolicyModel(java.lang.String policyDefinitionId)
Returns thePolicyModel
including all policy model info.PolicyModel
getPolicyModelByKey(java.lang.String policyDefinitionKey)
Returns thePolicyModel
including all policy model info, using the policy definition key and resolving the key to the latest version.PolicyModel
getPolicyModelByKeyAndTenantId(java.lang.String policyDefinitionKey, java.lang.String tenantId)
Returns thePolicyModel
including all policy model info, using the policy definition key and resolving the key to the latest version.java.io.InputStream
getResourceAsStream(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 thePolicyModel
including all policy model info. -
getPolicyModelByKey
Returns thePolicyModel
including 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 thePolicyModel
including 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 thePolicyModel
as a JSON string. -
getPolicyDefinition
Returns thePolicyDefinition
including all policy information like additional Properties (e.g. documentation). -
getPolicyDefinitionByKey
Returns thePolicyDefinition
including 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 thePolicyDefinition
including all policy information like additional Properties (e.g. documentation). The latest version for the given key will be returned. -
getPolicyDefinitionLinks
ReturnsPolicyDefinitionLink
s for the given policy definition id. -
addPolicyDefinitionLink
PolicyDefinitionLink addPolicyDefinitionLink(java.lang.String policyDefinitionId, java.lang.String type, java.lang.String linkValue)Adds a newPolicyDefinitionLink
for the given policy definition id. -
deletePolicyDefinitionLink
void deletePolicyDefinitionLink(java.lang.String policyDefinitionLinkId)Deletes anPolicyDefinitionLink
for 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
-