org.csapi.jr.se.policy
Interface PolicyDomain

All Superinterfaces:
CsapiInterface, java.io.Serializable, Service

public interface PolicyDomain
extends Service

This interface represents a PolicyDomain.


Field Summary
 
Fields inherited from interface org.csapi.jr.se.Service
IN_SERVICE_STATE, OUT_OF_SERVICE_STATE
 
Method Summary
 void addPolicyDomainListener(org.csapi.jr.se.policy.PolicyDomainListener policyDomainListener)
          Adds a PolicyDomainListener which is interested in events generated by the PolicyDomain.
 org.csapi.jr.se.policy.PolicyDomain createDomain(java.lang.String domainName)
          Invokes the createDomain() method on the Parlay Gateway.
 org.csapi.jr.se.policy.PolicyEventDefinition createEventDefinition(java.lang.String eventDefinitionName, java.lang.String[] requiredAttributes, java.lang.String[] optionalAttributes)
          Invokes the createEventDefinition() method on the Parlay Gateway.
 org.csapi.jr.se.policy.PolicyGroup createGroup(java.lang.String groupName)
          Invokes the createGroup() method on the Parlay Gateway.
 org.csapi.jr.se.policy.Notification createNotification()
          Creates a Notification object and returns a reference to the interface used to gain access to it's methods.
 org.csapi.jr.se.policy.PolicyRule createRule(java.lang.String ruleName)
          Invokes the createRule() method on the Parlay Gateway.
 void createVariableSet(java.lang.String variableSetName)
          Invokes the createVariableSet() method on the Parlay Gateway.
 void generateEvent(java.lang.String eventDefinitionName, org.csapi.jr.se.Attribute[] attributes)
          Invokes the generateEvent() method on the Parlay Gateway.
 org.csapi.jr.se.policy.PolicyDomain getDomain(java.lang.String domainName)
          Invokes the getDomain() method on the Parlay Gateway.
 int getDomainCount()
          Invokes the getDomainCount() method on the Parlay Gateway.
 org.csapi.jr.se.policy.PolicyIterator getDomainIterator()
          Invokes the getDomainIterator() method on the Parlay Gateway.
 org.csapi.jr.se.policy.PolicyEventDefinition getEventDefinition(java.lang.String eventDefinitionName)
          Invokes the getEventDefinition() method on the Parlay Gateway.
 int getEventDefinitionCount()
          Invokes the getEventDefinitionCount() method on the Parlay Gateway.
 org.csapi.jr.se.policy.PolicyIterator getEventDefinitionIterator()
          Invokes the getEventDefinitionIterator() method on the Parlay Gateway.
 org.csapi.jr.se.policy.PolicyGroup getGroup(java.lang.String groupName)
          Invokes the getGroup() method on the Parlay Gateway.
 int getGroupCount()
          Invokes the getGroupCount() method on the Parlay Gateway.
 org.csapi.jr.se.policy.PolicyIterator getGroupIterator()
          Invokes the getGroupIterator() method on the Parlay Gateway.
 org.csapi.jr.se.policy.PolicyDomain getParentDomain()
          Invokes the getParentDomain() method on the Parlay Gateway.
 org.csapi.jr.se.policy.PolicyRule getRule(java.lang.String ruleName)
          Invokes the getRule() method on the Parlay Gateway.
 int getRuleCount()
          Invokes the getRuleCount() method on the Parlay Gateway.
 org.csapi.jr.se.policy.PolicyIterator getRuleIterator()
          Invokes the getRuleIterator() method on the Parlay Gateway.
 org.csapi.jr.se.Attribute getVariable(java.lang.String variableSetName, java.lang.String variableName)
          Invokes the getVariable() method on the Parlay Gateway.
 org.csapi.jr.se.Attribute[] getVariableSet(java.lang.String variableSetName)
          Invokes the getVariableSet() method on the Parlay Gateway.
 int getVariableSetCount()
          Invokes the getVariableSetCount() method on the Parlay Gateway.
 org.csapi.jr.se.policy.PolicyIterator getVariableSetIterator()
          Invokes the getVariableSetIterator() method on the Parlay Gateway.
 void removeDomain(java.lang.String domainName)
          Invokes the removeDomain() method on the Parlay Gateway.
 void removeEventDefinition(java.lang.String eventDefinitionName)
          Invokes the removeEventDefinition() method on the Parlay Gateway.
 void removeGroup(java.lang.String groupName)
          Invokes the removeGroup() method on the Parlay Gateway.
 void removePolicyDomainListener(org.csapi.jr.se.policy.PolicyDomainListener policyDomainListener)
          Removes a PolicyDomainListener which is no longer interested in events generated by the PolicyDomain.
 void removeRule(java.lang.String ruleName)
          Invokes the removeRule() method on the Parlay Gateway.
 void removeVariableSet(java.lang.String variableSetName)
          Invokes the removeVariableSet() method on the Parlay Gateway.
 void setVariable(java.lang.String variableSetName, org.csapi.jr.se.Attribute variable)
          Invokes the setVariable() method on the Parlay Gateway.
 
Methods inherited from interface org.csapi.jr.se.Service
addServiceStateChangeListener, getServiceState, removeServiceStateChangeListener, setCallback
 

Method Detail

addPolicyDomainListener

public void addPolicyDomainListener(org.csapi.jr.se.policy.PolicyDomainListener policyDomainListener)
Adds a PolicyDomainListener which is interested in events generated by the PolicyDomain.

Parameters:
policyDomainListener - A reference to the PolicyDomainListener which is to be added as a listener.

removePolicyDomainListener

public void removePolicyDomainListener(org.csapi.jr.se.policy.PolicyDomainListener policyDomainListener)
Removes a PolicyDomainListener which is no longer interested in events generated by the PolicyDomain.

Parameters:
policyDomainListener - A reference to the PolicyDomainListener which is to be removed as a listener.

getParentDomain

public org.csapi.jr.se.policy.PolicyDomain getParentDomain()
                                                    throws PlatformException,
                                                           CommonException
Invokes the getParentDomain() method on the Parlay Gateway.

PlatformException
CommonException

createDomain

public org.csapi.jr.se.policy.PolicyDomain createDomain(java.lang.String domainName)
                                                 throws PlatformException,
                                                        CommonException,
                                                        AccessViolationException,
                                                        SyntaxErrorException,
                                                        NameSpaceErrorException,
                                                        NoTransactionInProcessException
Invokes the createDomain() method on the Parlay Gateway.

PlatformException
CommonException
AccessViolationException
SyntaxErrorException
NameSpaceErrorException
NoTransactionInProcessException

getDomain

public org.csapi.jr.se.policy.PolicyDomain getDomain(java.lang.String domainName)
                                              throws PlatformException,
                                                     CommonException,
                                                     AccessViolationException,
                                                     SyntaxErrorException,
                                                     NameSpaceErrorException
Invokes the getDomain() method on the Parlay Gateway.

PlatformException
CommonException
AccessViolationException
SyntaxErrorException
NameSpaceErrorException

removeDomain

public void removeDomain(java.lang.String domainName)
                  throws PlatformException,
                         CommonException,
                         AccessViolationException,
                         SyntaxErrorException,
                         NameSpaceErrorException,
                         NoTransactionInProcessException
Invokes the removeDomain() method on the Parlay Gateway.

PlatformException
CommonException
AccessViolationException
SyntaxErrorException
NameSpaceErrorException
NoTransactionInProcessException

getDomainCount

public int getDomainCount()
                   throws PlatformException,
                          CommonException,
                          AccessViolationException
Invokes the getDomainCount() method on the Parlay Gateway.

PlatformException
CommonException
AccessViolationException

getDomainIterator

public org.csapi.jr.se.policy.PolicyIterator getDomainIterator()
                                                        throws PlatformException,
                                                               CommonException,
                                                               AccessViolationException
Invokes the getDomainIterator() method on the Parlay Gateway.

PlatformException
CommonException
AccessViolationException

createGroup

public org.csapi.jr.se.policy.PolicyGroup createGroup(java.lang.String groupName)
                                               throws PlatformException,
                                                      CommonException,
                                                      AccessViolationException,
                                                      SyntaxErrorException,
                                                      NameSpaceErrorException,
                                                      NoTransactionInProcessException
Invokes the createGroup() method on the Parlay Gateway.

PlatformException
CommonException
AccessViolationException
SyntaxErrorException
NameSpaceErrorException
NoTransactionInProcessException

getGroup

public org.csapi.jr.se.policy.PolicyGroup getGroup(java.lang.String groupName)
                                            throws PlatformException,
                                                   CommonException,
                                                   AccessViolationException,
                                                   SyntaxErrorException,
                                                   NameSpaceErrorException
Invokes the getGroup() method on the Parlay Gateway.

PlatformException
CommonException
AccessViolationException
SyntaxErrorException
NameSpaceErrorException

removeGroup

public void removeGroup(java.lang.String groupName)
                 throws PlatformException,
                        CommonException,
                        AccessViolationException,
                        SyntaxErrorException,
                        NameSpaceErrorException,
                        NoTransactionInProcessException
Invokes the removeGroup() method on the Parlay Gateway.

PlatformException
CommonException
AccessViolationException
SyntaxErrorException
NameSpaceErrorException
NoTransactionInProcessException

getGroupCount

public int getGroupCount()
                  throws PlatformException,
                         CommonException,
                         AccessViolationException
Invokes the getGroupCount() method on the Parlay Gateway.

PlatformException
CommonException
AccessViolationException

getGroupIterator

public org.csapi.jr.se.policy.PolicyIterator getGroupIterator()
                                                       throws PlatformException,
                                                              CommonException,
                                                              AccessViolationException
Invokes the getGroupIterator() method on the Parlay Gateway.

PlatformException
CommonException
AccessViolationException

createRule

public org.csapi.jr.se.policy.PolicyRule createRule(java.lang.String ruleName)
                                             throws PlatformException,
                                                    CommonException,
                                                    AccessViolationException,
                                                    SyntaxErrorException,
                                                    NameSpaceErrorException,
                                                    NoTransactionInProcessException
Invokes the createRule() method on the Parlay Gateway.

PlatformException
CommonException
AccessViolationException
SyntaxErrorException
NameSpaceErrorException
NoTransactionInProcessException

getRule

public org.csapi.jr.se.policy.PolicyRule getRule(java.lang.String ruleName)
                                          throws PlatformException,
                                                 CommonException,
                                                 AccessViolationException,
                                                 SyntaxErrorException,
                                                 NameSpaceErrorException
Invokes the getRule() method on the Parlay Gateway.

PlatformException
CommonException
AccessViolationException
SyntaxErrorException
NameSpaceErrorException

removeRule

public void removeRule(java.lang.String ruleName)
                throws PlatformException,
                       CommonException,
                       AccessViolationException,
                       SyntaxErrorException,
                       NameSpaceErrorException,
                       NoTransactionInProcessException
Invokes the removeRule() method on the Parlay Gateway.

PlatformException
CommonException
AccessViolationException
SyntaxErrorException
NameSpaceErrorException
NoTransactionInProcessException

getRuleCount

public int getRuleCount()
                 throws PlatformException,
                        CommonException,
                        AccessViolationException
Invokes the getRuleCount() method on the Parlay Gateway.

PlatformException
CommonException
AccessViolationException

getRuleIterator

public org.csapi.jr.se.policy.PolicyIterator getRuleIterator()
                                                      throws PlatformException,
                                                             CommonException,
                                                             AccessViolationException
Invokes the getRuleIterator() method on the Parlay Gateway.

PlatformException
CommonException
AccessViolationException

createEventDefinition

public org.csapi.jr.se.policy.PolicyEventDefinition createEventDefinition(java.lang.String eventDefinitionName,
                                                                          java.lang.String[] requiredAttributes,
                                                                          java.lang.String[] optionalAttributes)
                                                                   throws PlatformException,
                                                                          CommonException,
                                                                          AccessViolationException,
                                                                          SyntaxErrorException,
                                                                          NameSpaceErrorException,
                                                                          NoTransactionInProcessException
Invokes the createEventDefinition() method on the Parlay Gateway.

PlatformException
CommonException
AccessViolationException
SyntaxErrorException
NameSpaceErrorException
NoTransactionInProcessException

getEventDefinition

public org.csapi.jr.se.policy.PolicyEventDefinition getEventDefinition(java.lang.String eventDefinitionName)
                                                                throws PlatformException,
                                                                       CommonException,
                                                                       AccessViolationException,
                                                                       SyntaxErrorException,
                                                                       NameSpaceErrorException
Invokes the getEventDefinition() method on the Parlay Gateway.

PlatformException
CommonException
AccessViolationException
SyntaxErrorException
NameSpaceErrorException

removeEventDefinition

public void removeEventDefinition(java.lang.String eventDefinitionName)
                           throws PlatformException,
                                  CommonException,
                                  AccessViolationException,
                                  SyntaxErrorException,
                                  NameSpaceErrorException,
                                  NoTransactionInProcessException
Invokes the removeEventDefinition() method on the Parlay Gateway.

PlatformException
CommonException
AccessViolationException
SyntaxErrorException
NameSpaceErrorException
NoTransactionInProcessException

getEventDefinitionCount

public int getEventDefinitionCount()
                            throws PlatformException,
                                   CommonException,
                                   AccessViolationException
Invokes the getEventDefinitionCount() method on the Parlay Gateway.

PlatformException
CommonException
AccessViolationException

getEventDefinitionIterator

public org.csapi.jr.se.policy.PolicyIterator getEventDefinitionIterator()
                                                                 throws PlatformException,
                                                                        CommonException,
                                                                        AccessViolationException
Invokes the getEventDefinitionIterator() method on the Parlay Gateway.

PlatformException
CommonException
AccessViolationException

generateEvent

public void generateEvent(java.lang.String eventDefinitionName,
                          org.csapi.jr.se.Attribute[] attributes)
                   throws PlatformException,
                          CommonException,
                          AccessViolationException,
                          SyntaxErrorException,
                          NameSpaceErrorException
Invokes the generateEvent() method on the Parlay Gateway.

PlatformException
CommonException
AccessViolationException
SyntaxErrorException
NameSpaceErrorException

createVariableSet

public void createVariableSet(java.lang.String variableSetName)
                       throws PlatformException,
                              CommonException,
                              AccessViolationException,
                              SyntaxErrorException,
                              NameSpaceErrorException,
                              NoTransactionInProcessException
Invokes the createVariableSet() method on the Parlay Gateway.

PlatformException
CommonException
AccessViolationException
SyntaxErrorException
NameSpaceErrorException
NoTransactionInProcessException

getVariableSet

public org.csapi.jr.se.Attribute[] getVariableSet(java.lang.String variableSetName)
                                           throws PlatformException,
                                                  CommonException,
                                                  AccessViolationException,
                                                  SyntaxErrorException,
                                                  NameSpaceErrorException
Invokes the getVariableSet() method on the Parlay Gateway.

PlatformException
CommonException
AccessViolationException
SyntaxErrorException
NameSpaceErrorException

removeVariableSet

public void removeVariableSet(java.lang.String variableSetName)
                       throws PlatformException,
                              CommonException,
                              AccessViolationException,
                              SyntaxErrorException,
                              NameSpaceErrorException,
                              NoTransactionInProcessException
Invokes the removeVariableSet() method on the Parlay Gateway.

PlatformException
CommonException
AccessViolationException
SyntaxErrorException
NameSpaceErrorException
NoTransactionInProcessException

getVariableSetCount

public int getVariableSetCount()
                        throws PlatformException,
                               CommonException,
                               AccessViolationException
Invokes the getVariableSetCount() method on the Parlay Gateway.

PlatformException
CommonException
AccessViolationException

getVariableSetIterator

public org.csapi.jr.se.policy.PolicyIterator getVariableSetIterator()
                                                             throws PlatformException,
                                                                    CommonException,
                                                                    AccessViolationException
Invokes the getVariableSetIterator() method on the Parlay Gateway.

PlatformException
CommonException
AccessViolationException

setVariable

public void setVariable(java.lang.String variableSetName,
                        org.csapi.jr.se.Attribute variable)
                 throws PlatformException,
                        CommonException,
                        AccessViolationException,
                        SyntaxErrorException,
                        NameSpaceErrorException,
                        NoTransactionInProcessException
Invokes the setVariable() method on the Parlay Gateway.

PlatformException
CommonException
AccessViolationException
SyntaxErrorException
NameSpaceErrorException
NoTransactionInProcessException

getVariable

public org.csapi.jr.se.Attribute getVariable(java.lang.String variableSetName,
                                             java.lang.String variableName)
                                      throws PlatformException,
                                             CommonException,
                                             AccessViolationException,
                                             SyntaxErrorException,
                                             NameSpaceErrorException
Invokes the getVariable() method on the Parlay Gateway.

PlatformException
CommonException
AccessViolationException
SyntaxErrorException
NameSpaceErrorException

createNotification

public org.csapi.jr.se.policy.Notification createNotification()
Creates a Notification object and returns a reference to the interface used to gain access to it's methods.

Returns:
A reference to the Notification interface.