org.csapi.jr.se.mm
Class MobilityStopAssignmentData

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

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

Defines the Sequence of Data Elements that specify a request to stop whole or parts of an assignment. Assignments are used for periodic or triggered reporting of a user's location or status. Note that the parameter 'Users' is optional. If the parameter 'StopScope' is set to P_M_ALL_IN_ASSIGNMENT the parameter 'Users' is undefined. If the parameter 'StopScope' is set to P_M_SPECIFIED_USERS, then the assignment shall be stopped only for those users specified in the 'Users' list.

See Also:
Serialized Form

Constructor Summary
MobilityStopAssignmentData()
          Creates a new MobilityStopAssignmentData instance.
MobilityStopAssignmentData(int _assignmentId, org.csapi.jr.se.mm.MobilityStopScope _stopScope, org.csapi.jr.se.Address[] _users)
          Creates a new MobilityStopAssignmentData instance.
 
Method Summary
 boolean equals(java.lang.Object o)
          Indicates whether some other object is 'equal to' this one.
 int getAssignmentId()
          This method returns a assignmentId.
 org.csapi.jr.se.mm.MobilityStopScope getStopScope()
          This method returns a stopScope.
 org.csapi.jr.se.Address[] getUsers()
          This method returns a users.
 int hashCode()
          Returns a hashcode value for the object.
 void setAssignmentId(int assignmentId)
          This method sets a assignmentId.
 void setStopScope(org.csapi.jr.se.mm.MobilityStopScope stopScope)
          This method sets a stopScope.
 void setUsers(org.csapi.jr.se.Address[] users)
          This method sets a users.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MobilityStopAssignmentData

public MobilityStopAssignmentData()
Creates a new MobilityStopAssignmentData instance.


MobilityStopAssignmentData

public MobilityStopAssignmentData(int _assignmentId,
                                  org.csapi.jr.se.mm.MobilityStopScope _stopScope,
                                  org.csapi.jr.se.Address[] _users)
Creates a new MobilityStopAssignmentData instance.

Parameters:
_assignmentId - Identity of the assignment that shall be stopped.
_stopScope - Specify if only a part of the assignment or if all the assignment shall be stopped.
_users - Optional parameter describing which users a stop request is addressing, when only a part of an assignment is to be stopped.
Method Detail

getAssignmentId

public int getAssignmentId()
This method returns a assignmentId.

Returns:
a int value

getStopScope

public org.csapi.jr.se.mm.MobilityStopScope getStopScope()
This method returns a stopScope.

Returns:
a org.csapi.jr.se.mm.MobilityStopScope value

getUsers

public org.csapi.jr.se.Address[] getUsers()
This method returns a users.

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

setAssignmentId

public void setAssignmentId(int assignmentId)
This method sets a assignmentId.


setStopScope

public void setStopScope(org.csapi.jr.se.mm.MobilityStopScope stopScope)
This method sets a stopScope.


setUsers

public void setUsers(org.csapi.jr.se.Address[] users)
This method sets a users.


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