|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PolicyQueryManager
Defines Policy specific querying operations.
Method Summary | |
---|---|
void |
clearPolicyCache()
Clear the policy cache |
java.util.List<Policy> |
findActivePoliciesForAssets(java.util.Collection<javax.xml.registry.infomodel.RegistryObject> assets,
javax.xml.registry.infomodel.Concept eventType)
Get the list of Policies applicable for the given ROs and event type |
java.util.List<Policy> |
findPolicies(javax.xml.registry.infomodel.RegistryObject regObj,
javax.xml.registry.infomodel.Concept eventType)
Get the list of Policies applicable for the given RO 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)
Get the list of Policies applicable for the given RO, event type and a target state to which transition is to be made |
java.util.Collection<PolicyActionCategory> |
getActionCategories(PolicyType policyType)
Get the collection of Action Categories applicable for the specified type |
java.util.Collection<PolicyActionCategory> |
getAllActionCategories()
get the collection of all Action Categories |
IPolicyStatus |
getASPolicyStatus(java.lang.String policyStatus)
The help to generate IPolicyStatus object for a given Policy Status value This method can be used under the JAXR/Policy engine layer. |
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)
Get the collection of non-global org-specific policies for the given policy type and organization |
java.util.Collection<Policy> |
getPolicies(PolicyType policyType)
Get the collection of Policies for the given type |
java.util.Collection<Policy> |
getPolicies(PolicyType policyType,
java.lang.String keywordSearch)
Get the collection of Policies for the given type |
Policy |
getPolicy(com.centrasite.jaxr.infomodel.CentraSiteRegistryEntry registryEntry)
Get the Policy object for the given registryEntry |
Policy |
getPolicy(java.lang.String policyId)
Get the Policy object for the given id |
PolicyActionTemplate |
getPolicyAction(com.centrasite.jaxr.infomodel.CentraSiteRegistryEntry registryEntry)
Get the Policy Action object for the given registryEntry |
PolicyActionTemplate |
getPolicyAction(java.lang.String policyActionId)
Get the Policy Action object for the given id |
PolicyActionCategory |
getPolicyActionCategory(com.centrasite.jaxr.infomodel.CentraSiteConcept actionCategoryConcept)
Get the Action Category for the given Category concept |
PolicyActionCategory |
getPolicyActionCategory(java.lang.String actionCategoryConceptId)
Get the Action Category for the given category id |
PolicyActionInstance |
getPolicyActionInstance(com.centrasite.jaxr.infomodel.CentraSiteAssociation actionInstanceAssociation)
Get the Policy Action Instance object for the given association object |
PolicyActionInstance |
getPolicyActionInstance(java.lang.String actionInstanceId)
Get the Policy Action Instance object for the given actionInstanceId |
PolicyActionParameter |
getPolicyActionParameter(com.centrasite.jaxr.infomodel.CentraSiteRegistryEntry registryEntry)
Get the Policy Action Parameter object for the given registryEntry |
PolicyActionParameter |
getPolicyActionParameter(java.lang.String policyActionParameterId)
Get the Policy Action Parameter object for the given id |
PolicyCondition |
getPolicyCondition(com.centrasite.jaxr.infomodel.CentraSiteRegistryEntry registryEntry)
Get the Policy Condition object for the given registryEntry |
PolicyCondition |
getPolicyCondition(java.lang.String policyConditionId)
Get the Policy Condition object for the given policyConditionId |
PolicyParameter |
getPolicyParameter(com.centrasite.jaxr.infomodel.CentraSiteRegistryEntry registryEntry)
Get the Policy Parameter object for the given registryEntry |
PolicyParameter |
getPolicyParameter(java.lang.String policyParameterId)
Get 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 |
Method Detail |
---|
java.util.Collection<PolicyActionCategory> getAllActionCategories() throws javax.xml.registry.JAXRException, PolicyException
javax.xml.registry.JAXRException
PolicyException
java.util.Collection<PolicyActionCategory> getActionCategories(PolicyType policyType) throws javax.xml.registry.JAXRException, PolicyException
policyType
- whether Design/Change Time or Runtime
javax.xml.registry.JAXRException
PolicyException
PolicyActionCategory getPolicyActionCategory(java.lang.String actionCategoryConceptId) throws javax.xml.registry.JAXRException, PolicyException
actionCategoryConceptId
- id for which Policy Action Category is to be fetched
javax.xml.registry.JAXRException
PolicyException
- if the object is not a 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 fetched
javax.xml.registry.JAXRException
PolicyException
- if the concept is not a Action CategoryPolicyActionTemplate getPolicyAction(java.lang.String policyActionId) throws PolicyException, javax.xml.registry.JAXRException
policyActionId
- id for which Policy Action is to be fetched
PolicyException
- if the object is not a Policy Action
javax.xml.registry.JAXRException
PolicyActionTemplate getPolicyAction(com.centrasite.jaxr.infomodel.CentraSiteRegistryEntry registryEntry) throws PolicyException, javax.xml.registry.JAXRException
registryEntry
- registryEntry for which Policy Action is to be fetched
PolicyException
- if the object is not a Policy Action
javax.xml.registry.JAXRException
PolicyActionParameter getPolicyActionParameter(java.lang.String policyActionParameterId) throws PolicyException, javax.xml.registry.JAXRException
policyActionParameterId
- id for which Policy Action Parameter is to be fetched
PolicyException
- if the object is not a Policy Action Parameter
javax.xml.registry.JAXRException
PolicyActionParameter getPolicyActionParameter(com.centrasite.jaxr.infomodel.CentraSiteRegistryEntry registryEntry) throws PolicyException, javax.xml.registry.JAXRException
registryEntry
- registryEntry for which Policy Action Parameter is to be fetched
PolicyException
- if the object is not a Policy Action Parameter
javax.xml.registry.JAXRException
java.util.Collection<Policy> getPolicies(PolicyType policyType) throws javax.xml.registry.JAXRException, PolicyException
policyType
- whether Design/Change Time or Runtime
javax.xml.registry.JAXRException
PolicyException
java.util.Collection<Policy> getPolicies(PolicyType policyType, java.lang.String keywordSearch) throws javax.xml.registry.JAXRException, PolicyException
policyType
- whether Design/Change Time or RuntimekeywordSearch
- search based on the text
javax.xml.registry.JAXRException
PolicyException
java.util.List<Policy> findPolicies(javax.xml.registry.infomodel.RegistryObject regObj, javax.xml.registry.infomodel.Concept eventType) throws PolicyException, javax.xml.registry.JAXRException
regObj
- RO for which policies are to be firedeventType
- event type on which policies are to be fired
PolicyException
javax.xml.registry.JAXRException
java.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
- RO for which policies are to be firedeventType
- event type on which policies are to be firedtoState
- target state to which transition is to be made
javax.xml.registry.JAXRException
PolicyException
Policy getPolicy(java.lang.String policyId) throws PolicyException, javax.xml.registry.JAXRException
policyId
- id for which Policy is to be fetched
PolicyException
- if the object is not a Policy
javax.xml.registry.JAXRException
Policy getPolicy(com.centrasite.jaxr.infomodel.CentraSiteRegistryEntry registryEntry) throws PolicyException, javax.xml.registry.JAXRException
registryEntry
- registryEntry for which Policy is to be fetched
PolicyException
- if the object is not a Policy
javax.xml.registry.JAXRException
PolicyActionInstance getPolicyActionInstance(java.lang.String actionInstanceId) throws javax.xml.registry.JAXRException, PolicyException
actionInstanceId
- id for which Policy Action Instance is to be fetched
javax.xml.registry.JAXRException
PolicyException
- 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 Policy Action Instance is to be fetched
javax.xml.registry.JAXRException
PolicyException
- if the association object is not a Policy Action InstancePolicyParameter getPolicyParameter(java.lang.String policyParameterId) throws PolicyException, javax.xml.registry.JAXRException
policyParameterId
- id for which Policy Parameter is to be fetched
PolicyException
- if the object is not a Policy Parameter
javax.xml.registry.JAXRException
PolicyParameter getPolicyParameter(com.centrasite.jaxr.infomodel.CentraSiteRegistryEntry registryEntry) throws PolicyException, javax.xml.registry.JAXRException
registryEntry
- registryEntry for which Policy Parameter is to be fetched
PolicyException
- if the object is not a Policy Parameter
javax.xml.registry.JAXRException
PolicyCondition getPolicyCondition(java.lang.String policyConditionId) throws PolicyException, javax.xml.registry.JAXRException
policyConditionId
- id for which Policy Condition is to be fetched
PolicyException
- if the object is not a Policy Condition
javax.xml.registry.JAXRException
PolicyCondition getPolicyCondition(com.centrasite.jaxr.infomodel.CentraSiteRegistryEntry registryEntry) throws PolicyException, javax.xml.registry.JAXRException
registryEntry
- registryEntry for which Policy Condition is to be fetched
PolicyException
- if the object is not a Policy Condition
javax.xml.registry.JAXRException
void 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
- for which org-specific policies are needed
javax.xml.registry.JAXRException
PolicyException
boolean isPolicyDefinedForType(javax.xml.registry.infomodel.Concept typeConcept) throws javax.xml.registry.JAXRException
typeConcept
-
javax.xml.registry.JAXRException
java.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
- ROs for which policies are to be firedeventType
- event type on which policies are to be fired
javax.xml.registry.JAXRException
PolicyException
IPolicyStatus getASPolicyStatus(java.lang.String policyStatus)
policyStatus
-
boolean isNewPolicyClient()
IPolicyStatus getInProgressStatus()
IPolicyStatus getSuccessStatus()
IPolicyStatus getInfoStatus()
IPolicyStatus getWarningStatus()
IPolicyStatus getFailureStatus()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |