org.csapi.jr.se.pam
Class PAMAPSEventData

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

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

This is a Sequence of Data Elements to specify the input data for subscribing to agent presence set events. The event is registered for changes in any of the named attributes. If no attributes are named, then the event is registered for all attributes in the presence information.

See Also:
Serialized Form

Constructor Summary
PAMAPSEventData()
          Creates a new PAMAPSEventData instance.
PAMAPSEventData(java.lang.String[] _agentName, java.lang.String[] _agentType, java.lang.String[] _attributeNames, long _reportingPeriod)
          Creates a new PAMAPSEventData instance.
 
Method Summary
 boolean equals(java.lang.Object o)
          Indicates whether some other object is 'equal to' this one.
 java.lang.String[] getAgentName()
          This method returns a agentName.
 java.lang.String[] getAgentType()
          This method returns a agentType.
 java.lang.String[] getAttributeNames()
          This method returns a attributeNames.
 long getReportingPeriod()
          This method returns a reportingPeriod.
 int hashCode()
          Returns a hashcode value for the object.
 void setAgentName(java.lang.String[] agentName)
          This method sets a agentName.
 void setAgentType(java.lang.String[] agentType)
          This method sets a agentType.
 void setAttributeNames(java.lang.String[] attributeNames)
          This method sets a attributeNames.
 void setReportingPeriod(long reportingPeriod)
          This method sets a reportingPeriod.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PAMAPSEventData

public PAMAPSEventData()
Creates a new PAMAPSEventData instance.


PAMAPSEventData

public PAMAPSEventData(java.lang.String[] _agentName,
                       java.lang.String[] _agentType,
                       java.lang.String[] _attributeNames,
                       long _reportingPeriod)
Creates a new PAMAPSEventData instance.

Parameters:
_agentName - Specifies the name of the agent for which the assignment is to be notified. Can be an empty array if notification is required for any agent instance.
_agentType - specifies the type of the agent for which this notification is requested if the agentName is specified as an empty array. Can be an empty array if notification required for agents of any type.
_attributeNames - Specifies attributes of interest. Can be an empty array
_reportingPeriod - Specifies the interval for periodic reporting (regardless of change). If -1, the event notification happens only on a change. If 0, there is a single immediate notification.
Method Detail

getAgentName

public java.lang.String[] getAgentName()
This method returns a agentName.

Returns:
a String[] value

getAgentType

public java.lang.String[] getAgentType()
This method returns a agentType.

Returns:
a String[] value

getAttributeNames

public java.lang.String[] getAttributeNames()
This method returns a attributeNames.

Returns:
a String[] value

getReportingPeriod

public long getReportingPeriod()
This method returns a reportingPeriod.

Returns:
a long value

setAgentName

public void setAgentName(java.lang.String[] agentName)
This method sets a agentName.


setAgentType

public void setAgentType(java.lang.String[] agentType)
This method sets a agentType.


setAttributeNames

public void setAttributeNames(java.lang.String[] attributeNames)
This method sets a attributeNames.


setReportingPeriod

public void setReportingPeriod(long reportingPeriod)
This method sets a reportingPeriod.


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