org.csapi.jr.se.policy
Class PolicyEvent

java.lang.Object
  |
  +--org.csapi.jr.se.policy.PolicyEvent
All Implemented Interfaces:
java.io.Serializable

public final class PolicyEvent
extends java.lang.Object
implements java.io.Serializable

This data type is a Sequence of Data Elements which describes a generic 'event'. Events can be generated in response to network activity, as a result of clients calling the generateEvent() method of IpPolicyDomain, or as a result of the evaluation of an IpPolicyEventAction action. Each instance of a generated event is identified by a unique EventID, a 32-bit integer. The time the event was generated is captured in the attribute TimeGenerated. All of the attributes in the RequiredAttributes list of the EventDefinition associated with the given EventDefinitionName must be present in Attributes. Any other attributes must be in the OptionalAttributes list of the same EventDefinition.

See Also:
Serialized Form

Constructor Summary
PolicyEvent()
          Creates a new PolicyEvent instance.
PolicyEvent(int _eventID, java.lang.String _timeGenerated, org.csapi.jr.se.Attribute[] _attributes, java.lang.String _eventDefinitionName, java.lang.String _eventDomainName)
          Creates a new PolicyEvent instance.
 
Method Summary
 boolean equals(java.lang.Object o)
          Indicates whether some other object is 'equal to' this one.
 org.csapi.jr.se.Attribute[] getAttributes()
          This method returns a attributes.
 java.lang.String getEventDefinitionName()
          This method returns a eventDefinitionName.
 java.lang.String getEventDomainName()
          This method returns a eventDomainName.
 int getEventID()
          This method returns a eventID.
 java.lang.String getTimeGenerated()
          This method returns a timeGenerated.
 int hashCode()
          Returns a hashcode value for the object.
 void setAttributes(org.csapi.jr.se.Attribute[] attributes)
          This method sets a attributes.
 void setEventDefinitionName(java.lang.String eventDefinitionName)
          This method sets a eventDefinitionName.
 void setEventDomainName(java.lang.String eventDomainName)
          This method sets a eventDomainName.
 void setEventID(int eventID)
          This method sets a eventID.
 void setTimeGenerated(java.lang.String timeGenerated)
          This method sets a timeGenerated.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PolicyEvent

public PolicyEvent()
Creates a new PolicyEvent instance.


PolicyEvent

public PolicyEvent(int _eventID,
                   java.lang.String _timeGenerated,
                   org.csapi.jr.se.Attribute[] _attributes,
                   java.lang.String _eventDefinitionName,
                   java.lang.String _eventDomainName)
Creates a new PolicyEvent instance.

Parameters:
_eventID -
_timeGenerated -
_attributes -
_eventDefinitionName -
_eventDomainName -
Method Detail

getEventID

public int getEventID()
This method returns a eventID.

Returns:
a int value

getTimeGenerated

public java.lang.String getTimeGenerated()
This method returns a timeGenerated.

Returns:
a String value

getAttributes

public org.csapi.jr.se.Attribute[] getAttributes()
This method returns a attributes.

Returns:
a org.csapi.jr.se.Attribute[] value

getEventDefinitionName

public java.lang.String getEventDefinitionName()
This method returns a eventDefinitionName.

Returns:
a String value

getEventDomainName

public java.lang.String getEventDomainName()
This method returns a eventDomainName.

Returns:
a String value

setEventID

public void setEventID(int eventID)
This method sets a eventID.


setTimeGenerated

public void setTimeGenerated(java.lang.String timeGenerated)
This method sets a timeGenerated.


setAttributes

public void setAttributes(org.csapi.jr.se.Attribute[] attributes)
This method sets a attributes.


setEventDefinitionName

public void setEventDefinitionName(java.lang.String eventDefinitionName)
This method sets a eventDefinitionName.


setEventDomainName

public void setEventDomainName(java.lang.String eventDomainName)
This method sets a eventDomainName.


equals

public boolean equals(java.lang.Object o)
Indicates whether some other object is 'equal to' this one.

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Returns a hashcode value for the object.

Overrides:
hashCode in class java.lang.Object