org.csapi.jr.se.pam
Class PAMIPSEventData

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

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

This is a Sequence of Data Elements to specify the input data for subscribing to identity 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
PAMIPSEventData()
          Creates a new PAMIPSEventData instance.
PAMIPSEventData(java.lang.String[] _identityName, java.lang.String[] _identityType, java.lang.String[] _attributeNames, long _reportingPeriod)
          Creates a new PAMIPSEventData instance.
 
Method Summary
 boolean equals(java.lang.Object o)
          Indicates whether some other object is 'equal to' this one.
 java.lang.String[] getAttributeNames()
          This method returns a attributeNames.
 java.lang.String[] getIdentityName()
          This method returns a identityName.
 java.lang.String[] getIdentityType()
          This method returns a identityType.
 long getReportingPeriod()
          This method returns a reportingPeriod.
 int hashCode()
          Returns a hashcode value for the object.
 void setAttributeNames(java.lang.String[] attributeNames)
          This method sets a attributeNames.
 void setIdentityName(java.lang.String[] identityName)
          This method sets a identityName.
 void setIdentityType(java.lang.String[] identityType)
          This method sets a identityType.
 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

PAMIPSEventData

public PAMIPSEventData()
Creates a new PAMIPSEventData instance.


PAMIPSEventData

public PAMIPSEventData(java.lang.String[] _identityName,
                       java.lang.String[] _identityType,
                       java.lang.String[] _attributeNames,
                       long _reportingPeriod)
Creates a new PAMIPSEventData instance.

Parameters:
_identityName - Specifies the name of the identity for which the assignment is to be notified. Can be an empty array if notification is required for any identity instance.
_identityType - Specifies the type of the identity for which this notification is requested if the identityName is specified as an empty array. Can be an empty array if notification required for identities 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 even if there is no change. For all other values, there is a periodic notification at the specified time interval regardless of change.
Method Detail

getIdentityName

public java.lang.String[] getIdentityName()
This method returns a identityName.

Returns:
a String[] value

getIdentityType

public java.lang.String[] getIdentityType()
This method returns a identityType.

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

setIdentityName

public void setIdentityName(java.lang.String[] identityName)
This method sets a identityName.


setIdentityType

public void setIdentityType(java.lang.String[] identityType)
This method sets a identityType.


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