public interface Policy extends PolicyRegistryObject
Modifier and Type | Method and Description |
---|---|
void |
addActionInstance(PolicyActionInstance policyActionInstance)
Adds the action instance to this policy.
|
void |
addEventType(Concept eventTypeConcept)
Adds the given event type(if not present already) to the collection of event types on which the policy will be
fired.
|
void |
addObjectType(Concept objectTypeConcept)
Adds the given object type(if not present already) to the collection of object types on which the policy will be
fired.
|
PolicyActionInstance |
getActionInstance(java.lang.String actionInstanceId)
Gets the policy action instance(if any) with the given ID.
|
java.util.List<PolicyActionInstance> |
getActionInstances()
Gets the list of action instances for the policy.
|
java.util.List<PolicyActionInstance> |
getActionInstancesByTemplateId(java.lang.String actionTemplateId)
Gets the list of policy action instances for the given policy action template ID.
|
java.util.Collection<com.centrasite.jaxr.infomodel.CentraSiteRegistryObject> |
getAllRegistryObjects()
Get the policy registry object together with its policy parameter registry objects and policy conditions if present.
|
PolicyCondition |
getApplicableCondition()
Gets the applicable condition(if any) for the policy.
|
EvaluationMode |
getEvaluationMode()
Gets the Evaluation Mode for the policy Only the Sequential mode of evaluation is supported currently.
|
java.util.Collection<Concept> |
getEventTypes()
Gets the collection of event types on which the policy will be fired.
|
java.util.Collection<Concept> |
getObjectTypes()
Gets the collection of object types on which the policy will be fired.
|
java.util.List<Key> |
getPolicyActionKeys()
Gets the list of policy action keys which are associated with this policy.
|
PolicyType |
getPolicyType()
Gets the Type of the policy.
|
int |
getPriority()
Gets the priority of the policy.
|
java.util.List<com.centrasite.jaxr.infomodel.CentraSiteRegistryObject> |
getRegistryObjectsToExport()
Returns the list of Registry Objects that need to be exported including this policy.
|
java.lang.String |
getUserVersion()
Gets the user version number from the underlying policy JAXR object.
|
int |
getVersion()
Gets the version number for this policy.
|
boolean |
isActive()
Returns whether this policy is active Only active policies will be fired.
|
boolean |
isGlobal()
Returns if this policy is Global.
|
boolean |
isHidden()
Returns whether this policy is hidden.
|
boolean |
isSystem()
Returns whether this policy is system defined.
|
boolean |
isUserDefined()
Returns whether this policy is user defined.
|
void |
removeActionInstance(PolicyActionInstance actionInstance)
Removes the action instance from the list of action instances for this policy(if present).
|
void |
removeActionInstances(java.util.List<PolicyActionInstance> actionInstances)
Removes the list of action instances from the list of action instances for this policy.
|
void |
setActionInstances(java.util.List<PolicyActionInstance> policyActionInstances)
Sets the action instances of this policy to the given list.
|
void |
setApplicableCondition(PolicyCondition condition)
Sets the applicable condition for this policy.
|
void |
setEvaluationMode(EvaluationMode evaluationMode)
Sets the Evaluation Mode for the policy.
|
void |
setEventTypes(java.util.Collection<Concept> eventTypeConcepts)
Sets the given event types(replacing any event type added/set before) as the collection of event types on which
the policy will be fired.
|
void |
setGlobal(boolean global)
Set the Global flag.
|
void |
setHidden()
Classifies this policy as Hidden.
|
void |
setObjectTypes(java.util.Collection<Concept> objectTypeConcepts)
Sets the given object types(replacing any event type added/set before) as the collection of object types on which
the policy will be fired.
|
void |
setPolicyType(PolicyType policyType)
Sets the Type of the policy.
|
void |
setPriority(int priority)
Sets the priority of the policy.
|
void |
setSystem()
Classifies this policy as system defined.
|
void |
setUserDefined()
Classifies this policy as user defined.
|
void |
setUserVersion(java.lang.String userVersion)
Sets the user version number for the underlying policy JAXR object.
|
boolean |
verify()
Verifies whether all mandatory parameters of this policy are set.
|
addAssociation, addAssociation, getAllClassifiedConcepts, getAllJAXRObjects, getAllObsoleteObjects, getAssociations, getAssociations, getClassifications, getClassifiedConcept, getDescription, getJAXRObject, getJAXRRegistryService, getKey, getLoggedInUserLocale, getName, removeAllAssociations, removeAllClassifications, setDescription, setName, toXMLForRepair
void addActionInstance(PolicyActionInstance policyActionInstance) throws JAXRException, PolicyException
policyActionInstance
- action instance to be addedJAXRException
- if an internal error occurs on adding an action instancePolicyException
- - if an internal error occursvoid setActionInstances(java.util.List<PolicyActionInstance> policyActionInstances) throws JAXRException, PolicyException
policyActionInstances
- the list of action instances to be setJAXRException
- if an occurs internal error while updating an action instancePolicyException
- if an internal error occursjava.util.List<PolicyActionInstance> getActionInstances() throws JAXRException, PolicyException
JAXRException
- if an internal error occurs while retrieving action instancesPolicyException
- if an internal error occursPolicyActionInstance getActionInstance(java.lang.String actionInstanceId) throws JAXRException, PolicyException
actionInstanceId
- the ID of the action instanceJAXRException
- if an internal error occurs while retrieving action instancePolicyException
- if an internal error occursjava.util.List<PolicyActionInstance> getActionInstancesByTemplateId(java.lang.String actionTemplateId) throws JAXRException, PolicyException
actionTemplateId
- the policy action template ID for which the action instances are neededJAXRException
- if an internal error occurs while retrieving action instance by template idPolicyException
- if an internal error occursvoid removeActionInstance(PolicyActionInstance actionInstance) throws JAXRException, PolicyException
actionInstance
- the action instance to be removedJAXRException
- if an internal error occurs while removing the action instancePolicyException
- if an internal error occursvoid removeActionInstances(java.util.List<PolicyActionInstance> actionInstances) throws JAXRException, PolicyException
actionInstances
- the list of action instances to be removedJAXRException
- if an internal error occurs while retrieving action instancesPolicyException
- if an internal error occursvoid setApplicableCondition(PolicyCondition condition) throws JAXRException
condition
- the applicable conditionJAXRException
- if an internal error occurs while updating the applicable conditionPolicyCondition getApplicableCondition() throws JAXRException, PolicyException
JAXRException
- if an internal error occurs while retrieving the applicable condition for the policyPolicyException
- if an internal error occursint getPriority() throws JAXRException
JAXRException
- if an internal error occurs while retrieving the priority of the policyvoid setPriority(int priority) throws JAXRException, PolicyException
priority
- the priority to be setJAXRException
- if an internal error occurs while updating the priority of the policyPolicyException
- if an internal error occursboolean isGlobal() throws JAXRException
true
whether if this policy is Global, false
otherwiseJAXRException
- if an internal error occursvoid setGlobal(boolean global) throws JAXRException
global
- the global flag to be setJAXRException
- if an internal error occursEvaluationMode getEvaluationMode() throws JAXRException
JAXRException
- if an internal error occurs while retrieving the evaluation modevoid setEvaluationMode(EvaluationMode evaluationMode) throws JAXRException
evaluationMode
- the Evaluation Mode to be setJAXRException
- if an internal error occurs while updating the evaluation modejava.util.Collection<Concept> getEventTypes() throws JAXRException
JAXRException
- if an internal error occurs while retrieving the collection of event typesvoid addEventType(Concept eventTypeConcept) throws JAXRException, PolicyException
eventTypeConcept
- the event type to be addedJAXRException
- if an internal error occurs while adding an event typePolicyException
- if an internal error occursvoid setEventTypes(java.util.Collection<Concept> eventTypeConcepts) throws JAXRException, PolicyException
eventTypeConcepts
- eventTypeConcepts to be setJAXRException
- if an internal error occurs while adding the event typesPolicyException
- if an internal error occursjava.util.Collection<Concept> getObjectTypes() throws JAXRException
JAXRException
- if an internal error occurs while retrieving the object typesvoid addObjectType(Concept objectTypeConcept) throws JAXRException, PolicyException
objectTypeConcept
- the object type to be addedJAXRException
- if an internal error occurs while adding an object typePolicyException
- if an internal error occursvoid setObjectTypes(java.util.Collection<Concept> objectTypeConcepts) throws JAXRException, PolicyException
objectTypeConcepts
- the collection of object types to be setJAXRException
- if an internal error occurs while updating object typesPolicyException
- if an internal error occursboolean isSystem() throws JAXRException
true
if this policy is system defined, false
otherwiseJAXRException
- if an internal error occursboolean isHidden() throws JAXRException
true
if this policy is hidden, false
otherwiseJAXRException
- if an internal error occursboolean isUserDefined() throws JAXRException
true
if this policy is user defined, false
otherwiseJAXRException
- if an internal error occursboolean isActive() throws JAXRException
true>
if this policy is active, false
otherwiseJAXRException
- if an internal error occursint getVersion() throws JAXRException
JAXRException
- if an internal error occurs on retrieving the versionvoid setSystem() throws JAXRException
JAXRException
- if an internal error occursvoid setHidden() throws JAXRException
JAXRException
- if an internal error occursvoid setUserDefined() throws JAXRException
JAXRException
- if an internal error occursboolean verify() throws JAXRException, PolicyException
JAXRException
- if an internal error occursPolicyException
- If there are mandatory parameters that are not setPolicyType getPolicyType() throws JAXRException
JAXRException
- if an internal error occurs on retrieving the policy typevoid setPolicyType(PolicyType policyType) throws JAXRException
policyType
- to be setJAXRException
- if an internal error occurs while updating the policy typejava.util.List<com.centrasite.jaxr.infomodel.CentraSiteRegistryObject> getRegistryObjectsToExport() throws JAXRException, PolicyException
JAXRException
- if an internal error occurs on retrieving the registry objects to exportPolicyException
- if an internal error occursvoid setUserVersion(java.lang.String userVersion) throws JAXRException
userVersion
- the user version number to be setJAXRException
- if an internal error occurs while updating user versionjava.lang.String getUserVersion() throws JAXRException
JAXRException
- if an internal error occurs on retrieving the user versionjava.util.List<Key> getPolicyActionKeys() throws JAXRException, PolicyException
JAXRException
- if an internal error occurs on retrieving the policy action keysPolicyException
- if an internal error occursjava.util.Collection<com.centrasite.jaxr.infomodel.CentraSiteRegistryObject> getAllRegistryObjects() throws JAXRException, PolicyException
getAllJAXRObjects()
the objects didn't get modified.JAXRException
PolicyException