|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Policy
Models a policy object
Method Summary | |
---|---|
void |
addActionInstance(PolicyActionInstance policyActionInstance)
Add the action instance to this policy |
void |
addEventType(javax.xml.registry.infomodel.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(javax.xml.registry.infomodel.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)
Get the policy action instance(if any) with the given Id |
java.util.List<PolicyActionInstance> |
getActionInstances()
Get the list of action instances for the policy |
java.util.List<PolicyActionInstance> |
getActionInstancesByTemplateId(java.lang.String actionTemplateId)
Get the list of policy action instance for the given policy action template id |
PolicyCondition |
getApplicableCondition()
Get the applicable condition(if any) for the policy |
EvaluationMode |
getEvaluationMode()
Get the Evaluation Mode for the policy Only Sequential mode of evaluation is supported currently |
java.util.Collection<javax.xml.registry.infomodel.Concept> |
getEventTypes()
Get the collection of event types on which the policy will be fired |
java.util.Collection<javax.xml.registry.infomodel.Concept> |
getObjectTypes()
Get the collection of object types on which the policy will be fired |
java.util.List<javax.xml.registry.infomodel.Key> |
getPolicyActionKeys()
Get the list of policy action keys which are associated to this policy |
PolicyType |
getPolicyType()
get the Type of the policy |
int |
getPriority()
Get 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()
Get the user version number from the underlying policy jaxr object |
int |
getVersion()
Get the version number for this policy |
boolean |
isActive()
Return if this policy is active Only active policies will be fired |
boolean |
isGlobal()
Return if this policy is Global |
boolean |
isHidden()
Return if this policy is hidden |
boolean |
isSystem()
Return if this policy is System defined |
boolean |
isUserDefined()
Return if this policy is user defined |
void |
removeActionInstance(PolicyActionInstance actionInstance)
Remove the action instance from the list of action instances for this policy(if present) |
void |
removeActionInstances(java.util.List<PolicyActionInstance> actionInstances)
Remove the list of action instances from the list of action instances for this policy |
void |
setActionInstances(java.util.List<PolicyActionInstance> policyActionInstances)
Set the action instances of this policy to the given list |
void |
setApplicableCondition(PolicyCondition condition)
Set the applicable condition for this policy |
void |
setEvaluationMode(EvaluationMode evaluationMode)
Set the Evaluation Mode for the policy |
void |
setEventTypes(java.util.Collection<javax.xml.registry.infomodel.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. if Global is set to true, it implies that the policy is applicable to all organizations if Global is set to false, it implies that the policy is applicable only to the organization in which it was created |
void |
setHidden()
Classify this policy as Hidden |
void |
setObjectTypes(java.util.Collection<javax.xml.registry.infomodel.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)
set the Type of the policy |
void |
setPriority(int priority)
Sets the priority of the policy. |
void |
setSystem()
Classify this policy as System defined |
void |
setUserDefined()
Classify this policy as User defined |
void |
setUserVersion(java.lang.String userVersion)
Set the user version number for the underlying policy jaxr object |
boolean |
verify()
Verify whether all mandatory parameters of this policy are set |
Methods inherited from interface com.softwareag.centrasite.policy.api.PolicyRegistryObject |
---|
addAssociation, addAssociation, getAllClassifiedConcepts, getAllJAXRObjects, getAllObsoleteObjects, getAssociations, getAssociations, getClassifications, getClassifiedConcept, getDescription, getJAXRObject, getJAXRRegistryService, getKey, getLoggedInUserLocale, getName, removeAllAssociations, removeAllClassifications, setDescription, setName, toXMLForRepair |
Method Detail |
---|
void addActionInstance(PolicyActionInstance policyActionInstance) throws javax.xml.registry.JAXRException, PolicyException
policyActionInstance
- action instance to be added
PolicyException
javax.xml.registry.JAXRException
void setActionInstances(java.util.List<PolicyActionInstance> policyActionInstances) throws javax.xml.registry.JAXRException, PolicyException
policyActionInstances
- list of action instances to be set
PolicyException
javax.xml.registry.JAXRException
java.util.List<PolicyActionInstance> getActionInstances() throws javax.xml.registry.JAXRException, PolicyException
javax.xml.registry.JAXRException
PolicyException
PolicyActionInstance getActionInstance(java.lang.String actionInstanceId) throws javax.xml.registry.JAXRException, PolicyException
actionInstanceId
- id of the action instance
javax.xml.registry.JAXRException
PolicyException
java.util.List<PolicyActionInstance> getActionInstancesByTemplateId(java.lang.String actionTemplateId) throws javax.xml.registry.JAXRException, PolicyException
actionTemplateId
- policy action template id for which the action instances are needed
javax.xml.registry.JAXRException
PolicyException
void removeActionInstance(PolicyActionInstance actionInstance) throws javax.xml.registry.JAXRException, PolicyException
actionInstance
- action instance to be removed
PolicyException
javax.xml.registry.JAXRException
void removeActionInstances(java.util.List<PolicyActionInstance> actionInstances) throws javax.xml.registry.JAXRException, PolicyException
actionInstances
- list of action instances to be removed
PolicyException
javax.xml.registry.JAXRException
void setApplicableCondition(PolicyCondition condition) throws javax.xml.registry.JAXRException
condition
- applicable condition
javax.xml.registry.JAXRException
PolicyCondition getApplicableCondition() throws javax.xml.registry.JAXRException, PolicyException
javax.xml.registry.JAXRException
PolicyException
int getPriority() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setPriority(int priority) throws javax.xml.registry.JAXRException, PolicyException
priority
- priority to be set
javax.xml.registry.JAXRException
PolicyException
boolean isGlobal() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setGlobal(boolean global) throws javax.xml.registry.JAXRException
global
- global flag to be set
javax.xml.registry.JAXRException
EvaluationMode getEvaluationMode() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setEvaluationMode(EvaluationMode evaluationMode) throws javax.xml.registry.JAXRException
evaluationMode
- Evaluation Mode to be set
javax.xml.registry.JAXRException
java.util.Collection<javax.xml.registry.infomodel.Concept> getEventTypes() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void addEventType(javax.xml.registry.infomodel.Concept eventTypeConcept) throws javax.xml.registry.JAXRException, PolicyException
eventTypeConcept
- event type to be added
javax.xml.registry.JAXRException
PolicyException
void setEventTypes(java.util.Collection<javax.xml.registry.infomodel.Concept> eventTypeConcepts) throws javax.xml.registry.JAXRException, PolicyException
eventTypeConcepts
- eventTypeConcepts to be set
javax.xml.registry.JAXRException
PolicyException
java.util.Collection<javax.xml.registry.infomodel.Concept> getObjectTypes() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void addObjectType(javax.xml.registry.infomodel.Concept objectTypeConcept) throws javax.xml.registry.JAXRException, PolicyException
objectTypeConcept
- object type to be added
javax.xml.registry.JAXRException
PolicyException
void setObjectTypes(java.util.Collection<javax.xml.registry.infomodel.Concept> objectTypeConcepts) throws javax.xml.registry.JAXRException, PolicyException
objectTypeConcepts
- objectTypeConcepts to be set
javax.xml.registry.JAXRException
PolicyException
boolean isSystem() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
boolean isHidden() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
boolean isUserDefined() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
boolean isActive() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
int getVersion() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setSystem() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setHidden() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setUserDefined() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
boolean verify() throws javax.xml.registry.JAXRException, PolicyException
javax.xml.registry.JAXRException
PolicyException
- If there are mandatory parameters that are not setPolicyType getPolicyType() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setPolicyType(PolicyType policyType) throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
java.util.List<com.centrasite.jaxr.infomodel.CentraSiteRegistryObject> getRegistryObjectsToExport() throws javax.xml.registry.JAXRException, PolicyException
javax.xml.registry.JAXRException
PolicyException
void setUserVersion(java.lang.String userVersion) throws javax.xml.registry.JAXRException
userVersion
-
javax.xml.registry.JAXRException
java.lang.String getUserVersion() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
java.util.List<javax.xml.registry.infomodel.Key> getPolicyActionKeys() throws javax.xml.registry.JAXRException, PolicyException
javax.xml.registry.JAXRException
PolicyException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |