public interface PolicyQueryManager
Modifier and Type | Method and Description |
---|---|
void |
clearPolicyCache()
Clears the policy cache.
|
java.util.List<Policy> |
findActivePoliciesForAssets(java.util.Collection<javax.xml.registry.infomodel.RegistryObject> assets,
javax.xml.registry.infomodel.Concept eventType)
Gets the list of Policies applicable for the given registry objects and event type.
|
java.util.List<Policy> |
findPolicies(javax.xml.registry.infomodel.RegistryObject regObj,
javax.xml.registry.infomodel.Concept eventType)
Gets the list of Policies applicable for the given registry object and event type.
|
java.util.List<Policy> |
findPolicies(javax.xml.registry.infomodel.RegistryObject regObj,
javax.xml.registry.infomodel.Concept eventType,
javax.xml.registry.infomodel.Concept toState)
Gets the list of Policies applicable for the given registry object, event type and a target state to which transition is to be
made.
|
java.util.Collection<PolicyActionCategory> |
getActionCategories(PolicyType policyType)
Gets the collection of Action Categories applicable for the specified type.
|
java.util.Collection<PolicyActionCategory> |
getAllActionCategories()
Gets the collection of all Action Categories.
|
IPolicyStatus |
getASPolicyStatus(java.lang.String policyStatus)
The help to generate IPolicyStatus object for a given Policy Status value.
|
IPolicyStatus |
getFailureStatus()
Helper method to return the Failure Policy.
|
IPolicyStatus |
getInfoStatus()
Helper method to return the Info Policy.
|
IPolicyStatus |
getInProgressStatus()
Helper method to return the InProgress Policy.
|
java.util.Collection<Policy> |
getOrganizationSpecificPolicies(PolicyType policyType,
javax.xml.registry.infomodel.Organization organization)
Gets the collection of non-global organization-specific policies for the given policy type and organization.
|
java.util.Collection<Policy> |
getPolicies(PolicyType policyType)
Gets the collection of Policies for the given type.
|
java.util.Collection<Policy> |
getPolicies(PolicyType policyType,
java.lang.String keywordSearch)
Gets the collection of Policies for the given type.
|
Policy |
getPolicy(com.centrasite.jaxr.infomodel.CentraSiteRegistryEntry registryEntry)
Gets the Policy object for the given registryEntry.
|
Policy |
getPolicy(java.lang.String policyId)
Gets the Policy object for the given ID.
|
PolicyActionTemplate |
getPolicyAction(com.centrasite.jaxr.infomodel.CentraSiteRegistryEntry registryEntry)
Gets the Policy Action object for the given registryEntry.
|
PolicyActionTemplate |
getPolicyAction(java.lang.String policyActionId)
Gets the Policy Action object for the given ID.
|
PolicyActionCategory |
getPolicyActionCategory(com.centrasite.jaxr.infomodel.CentraSiteConcept actionCategoryConcept)
Gets the Action Category for the given Category concept.
|
PolicyActionCategory |
getPolicyActionCategory(java.lang.String actionCategoryConceptId)
Gets the Action Category for the given category ID.
|
PolicyActionInstance |
getPolicyActionInstance(com.centrasite.jaxr.infomodel.CentraSiteAssociation actionInstanceAssociation)
Gets the Policy Action Instance object for the given association object.
|
PolicyActionInstance |
getPolicyActionInstance(java.lang.String actionInstanceId)
Gets the Policy Action Instance object for the given actionInstanceId.
|
PolicyActionParameter |
getPolicyActionParameter(com.centrasite.jaxr.infomodel.CentraSiteRegistryEntry registryEntry)
Gets the Policy Action Parameter object for the given registryEntry.
|
PolicyActionParameter |
getPolicyActionParameter(java.lang.String policyActionParameterId)
Gets the Policy Action Parameter object for the given ID.
|
PolicyCondition |
getPolicyCondition(com.centrasite.jaxr.infomodel.CentraSiteRegistryEntry registryEntry)
Gets the Policy Condition object for the given registryEntry.
|
PolicyCondition |
getPolicyCondition(java.lang.String policyConditionId)
Gets the Policy Condition object for the given policyConditionId.
|
PolicyParameter |
getPolicyParameter(com.centrasite.jaxr.infomodel.CentraSiteRegistryEntry registryEntry)
Gets the Policy Parameter object for the given registryEntry.
|
PolicyParameter |
getPolicyParameter(java.lang.String policyParameterId)
Gets the Policy Parameter object for the given policyParameterId.
|
IPolicyStatus |
getSuccessStatus()
Helper method to return the Success Policy.
|
IPolicyStatus |
getWarningStatus()
Helper method to return the Warning Policy.
|
boolean |
isNewPolicyClient()
True will be returned when a new policy client is been used in the CLASSPATH.
|
boolean |
isPolicyDefinedForType(javax.xml.registry.infomodel.Concept typeConcept)
Tells whether any policy is defined for the given asset type.
|
java.util.Collection<PolicyActionCategory> getAllActionCategories() throws javax.xml.registry.JAXRException, PolicyException
javax.xml.registry.JAXRException
- if encounters an internal error on retrieving all action categoriesPolicyException
- if encounters an internal errorjava.util.Collection<PolicyActionCategory> getActionCategories(PolicyType policyType) throws javax.xml.registry.JAXRException, PolicyException
policyType
- whether Design/Change Time or Runtimejavax.xml.registry.JAXRException
- if encounters an internal error on retrieving action categoryPolicyException
- if encounters an internal errorPolicyActionCategory getPolicyActionCategory(java.lang.String actionCategoryConceptId) throws javax.xml.registry.JAXRException, PolicyException
actionCategoryConceptId
- id for which Policy Action Category is to be fetchedjavax.xml.registry.JAXRException
- if encounters an internal errorPolicyException
- if the object is not an Action CategoryPolicyActionCategory getPolicyActionCategory(com.centrasite.jaxr.infomodel.CentraSiteConcept actionCategoryConcept) throws javax.xml.registry.JAXRException, PolicyException
actionCategoryConcept
- concept for which Policy Action Category is to be fetchedjavax.xml.registry.JAXRException
- if encounters an internal errorPolicyException
- if the concept is not an Action CategoryPolicyActionTemplate getPolicyAction(java.lang.String policyActionId) throws PolicyException, javax.xml.registry.JAXRException
policyActionId
- id for which Policy Action is to be fetchedPolicyException
- if the object is not a Policy Actionjavax.xml.registry.JAXRException
- if encounters an internal errorPolicyActionTemplate getPolicyAction(com.centrasite.jaxr.infomodel.CentraSiteRegistryEntry registryEntry) throws PolicyException, javax.xml.registry.JAXRException
registryEntry
- registryEntry for which the Policy Action is to be fetchedPolicyException
- if the object is not a Policy Actionjavax.xml.registry.JAXRException
- if encounters an internal errorPolicyActionParameter getPolicyActionParameter(java.lang.String policyActionParameterId) throws PolicyException, javax.xml.registry.JAXRException
policyActionParameterId
- the ID for which the Policy Action Parameter is to be fetchedPolicyException
- if the object is not a Policy Action Parameterjavax.xml.registry.JAXRException
- if encounters an internal errorPolicyActionParameter getPolicyActionParameter(com.centrasite.jaxr.infomodel.CentraSiteRegistryEntry registryEntry) throws PolicyException, javax.xml.registry.JAXRException
registryEntry
- registryEntry for which Policy Action Parameter is to be fetchedPolicyException
- if the object is not a Policy Action Parameterjavax.xml.registry.JAXRException
- if encounters an internal errorjava.util.Collection<Policy> getPolicies(PolicyType policyType) throws javax.xml.registry.JAXRException, PolicyException
policyType
- whether Design/Change Time or Runtimejavax.xml.registry.JAXRException
- if encounters an internal errorPolicyException
- if encounters an internal error on retrieving policiesjava.util.Collection<Policy> getPolicies(PolicyType policyType, java.lang.String keywordSearch) throws javax.xml.registry.JAXRException, PolicyException
policyType
- whether Design/Change Time or RuntimekeywordSearch
- search the policy based on the keywordjavax.xml.registry.JAXRException
- if encounters an internal errorPolicyException
- if encounters an internal error on retrieving policiesjava.util.List<Policy> findPolicies(javax.xml.registry.infomodel.RegistryObject regObj, javax.xml.registry.infomodel.Concept eventType) throws PolicyException, javax.xml.registry.JAXRException
regObj
- registry object for which policies are to be firedeventType
- event type on which policies are to be firedPolicyException
- if encounters an internal error on finding policiesjavax.xml.registry.JAXRException
- if encounters an internal errorjava.util.List<Policy> findPolicies(javax.xml.registry.infomodel.RegistryObject regObj, javax.xml.registry.infomodel.Concept eventType, javax.xml.registry.infomodel.Concept toState) throws javax.xml.registry.JAXRException, PolicyException
regObj
- registry object for which policies are to be firedeventType
- event type on which policies are to be firedtoState
- target state to which transition is to be madejavax.xml.registry.JAXRException
- if encounters an internal errorPolicyException
- if encounters an internal error on finding policiesPolicy getPolicy(java.lang.String policyId) throws PolicyException, javax.xml.registry.JAXRException
policyId
- the ID for which Policy is to be fetchedPolicyException
- if the object is not a Policyjavax.xml.registry.JAXRException
- if encounters an internal errorPolicy getPolicy(com.centrasite.jaxr.infomodel.CentraSiteRegistryEntry registryEntry) throws PolicyException, javax.xml.registry.JAXRException
registryEntry
- registryEntry for which Policy is to be fetchedPolicyException
- if the object is not a Policyjavax.xml.registry.JAXRException
- if encounters an internal errorPolicyActionInstance getPolicyActionInstance(java.lang.String actionInstanceId) throws javax.xml.registry.JAXRException, PolicyException
actionInstanceId
- the ID for which the Policy Action Instance is to be fetchedjavax.xml.registry.JAXRException
- if encounters an internal errorPolicyException
- if the object is not a Policy Action InstancePolicyActionInstance getPolicyActionInstance(com.centrasite.jaxr.infomodel.CentraSiteAssociation actionInstanceAssociation) throws javax.xml.registry.JAXRException, PolicyException
actionInstanceAssociation
- association for which the Policy Action Instance is to be fetchedjavax.xml.registry.JAXRException
- if encounters an internal errorPolicyException
- if the association object is not a Policy Action InstancePolicyParameter getPolicyParameter(java.lang.String policyParameterId) throws PolicyException, javax.xml.registry.JAXRException
policyParameterId
- the ID for which Policy Parameter is to be fetchedPolicyException
- if the object is not a Policy Parameterjavax.xml.registry.JAXRException
- if encounters an internal errorPolicyParameter getPolicyParameter(com.centrasite.jaxr.infomodel.CentraSiteRegistryEntry registryEntry) throws PolicyException, javax.xml.registry.JAXRException
registryEntry
- registryEntry for which the Policy Parameter is to be fetchedPolicyException
- if the object is not a Policy Parameterjavax.xml.registry.JAXRException
- if encounters an internal errorPolicyCondition getPolicyCondition(java.lang.String policyConditionId) throws PolicyException, javax.xml.registry.JAXRException
policyConditionId
- the ID for which Policy Condition is to be fetchedPolicyException
- if the object is not a Policy Conditionjavax.xml.registry.JAXRException
- if encounters an internal errorPolicyCondition getPolicyCondition(com.centrasite.jaxr.infomodel.CentraSiteRegistryEntry registryEntry) throws PolicyException, javax.xml.registry.JAXRException
registryEntry
- registryEntry for which Policy Condition is to be fetchedPolicyException
- if the object is not a Policy Conditionjavax.xml.registry.JAXRException
- if encounters an internal errorvoid clearPolicyCache()
java.util.Collection<Policy> getOrganizationSpecificPolicies(PolicyType policyType, javax.xml.registry.infomodel.Organization organization) throws javax.xml.registry.JAXRException, PolicyException
policyType
- whether Design/Change Time or Runtimeorganization
- the organization for which the organization-specific policies are neededjavax.xml.registry.JAXRException
- if encounters an internal errorPolicyException
- if encounters an internal error on retrieving organization specific policiesboolean isPolicyDefinedForType(javax.xml.registry.infomodel.Concept typeConcept) throws javax.xml.registry.JAXRException
typeConcept
- true
if any policy is exists already for the type; otherwise false
javax.xml.registry.JAXRException
- if encounters an internal errorjava.util.List<Policy> findActivePoliciesForAssets(java.util.Collection<javax.xml.registry.infomodel.RegistryObject> assets, javax.xml.registry.infomodel.Concept eventType) throws PolicyException, javax.xml.registry.JAXRException
assets
- registry objects for which policies are to be firedeventType
- event type on which policies are to be firedjavax.xml.registry.JAXRException
- if encounters an internal errorPolicyException
- if encounters an internal error on finding active policies for assetsIPolicyStatus getASPolicyStatus(java.lang.String policyStatus)
policyStatus
- the policy status valueIPolicyStatus
objectboolean isNewPolicyClient()
IPolicyStatus getInProgressStatus()
IPolicyStatus
IPolicyStatus getSuccessStatus()
IPolicyStatus
IPolicyStatus getInfoStatus()
IPolicyStatus
IPolicyStatus getWarningStatus()
IPolicyStatus
IPolicyStatus getFailureStatus()
IPolicyStatus