com.opencloud.slee.resources.cgin.map

Class MAPLCS_ClientID

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

MAPLCS_ClientID

All Implemented Interfaces:

DataObject, Serializable

public class MAPLCS_ClientID
extends AbstractFieldsObject

API for MAP-LCS-DataTypes.LCS-ClientID. Generated from the following ASN.1 type definition.

 LCS-ClientID ::=
     SEQUENCE {
         lcsClientType       LCSClientType,
         lcsClientExternalID LCSClientExternalID OPTIONAL,
         lcsClientDialedByMS AddressString OPTIONAL,
         lcsClientInternalID LCSClientInternalID OPTIONAL,
         lcsClientName       LCSClientName OPTIONAL,
         ...
         lcsAPN              APN OPTIONAL,                 -- Added in release 4.
         lcsRequestorID      LCSRequestorID OPTIONAL       -- Added in release 5.
     }
 

Added in R98.

Used as field type by MAPSubscriberLocationReport_Arg.

Used as field type by MAPProvideSubscriberLocation_Arg.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

Constructor and Description
MAPLCS_ClientID() Constructs an object with uninitialised state.

Method Summary

Methods

Modifier and Type	Method and Description
MAPLCS_ClientID	clone() Constructs a copy of this object and everything reachable from it.
static MAPLCS_ClientID	copyOf(MAPLCS_ClientID from) Creates a new object of this type, cloning the values of common fields from the given object of any subclass of the same base type.
static FieldAccessor[]	getFieldAccessors() Gets a new array of the accessors for fields of this type.
Map<String,Object>	getFieldsMap(boolean withAbsents) Gets a Map from field-name to field-value.
AccessPointName	getLcsAPN() Gets the value of the field lcsAPN.
AddressString	getLcsClientDialedByMS() Gets the value of the field lcsClientDialedByMS.
MAPLCSClientExternalID	getLcsClientExternalID() Gets the value of the field lcsClientExternalID.
MAPLCSClientInternalID	getLcsClientInternalID() Gets the value of the field lcsClientInternalID.
MAPLCSClientName	getLcsClientName() Gets the value of the field lcsClientName.
MAPLCSClientType	getLcsClientType() Gets the value of the field lcsClientType.
MAPLCSRequestorID	getLcsRequestorID() Gets the value of the field lcsRequestorID.
boolean	hasLcsAPN() Tests whether the field lcsAPN has a value.
boolean	hasLcsClientDialedByMS() Tests whether the field lcsClientDialedByMS has a value.
boolean	hasLcsClientExternalID() Tests whether the field lcsClientExternalID has a value.
boolean	hasLcsClientInternalID() Tests whether the field lcsClientInternalID has a value.
boolean	hasLcsClientName() Tests whether the field lcsClientName has a value.
boolean	hasLcsClientType() Tests whether the field lcsClientType has a value.
boolean	hasLcsRequestorID() Tests whether the field lcsRequestorID has a value.
MAPLCS_ClientID	setLcsAPN(AccessPointName value) Sets the value of the field lcsAPN.
MAPLCS_ClientID	setLcsClientDialedByMS(AddressString value) Sets the value of the field lcsClientDialedByMS.
MAPLCS_ClientID	setLcsClientExternalID(MAPLCSClientExternalID value) Sets the value of the field lcsClientExternalID.
MAPLCS_ClientID	setLcsClientInternalID(MAPLCSClientInternalID value) Sets the value of the field lcsClientInternalID.
MAPLCS_ClientID	setLcsClientName(MAPLCSClientName value) Sets the value of the field lcsClientName.
MAPLCS_ClientID	setLcsClientType(MAPLCSClientType value) Sets the value of the field lcsClientType.
MAPLCS_ClientID	setLcsRequestorID(MAPLCSRequestorID value) Sets the value of the field lcsRequestorID.
void	setReadOnly() Sets this and all its fields to be immutable.

Methods inherited from class com.opencloud.util.AbstractFieldsObject

equals, hashCode, toString

Methods inherited from class com.opencloud.util.AbstractDataObject

checkModify, isReadOnly

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MAPLCS_ClientID

public MAPLCS_ClientID()

Constructs an object with uninitialised state.

Method Detail

clone

public MAPLCS_ClientID clone()

Constructs a copy of this object and everything reachable from it.

Specified by:

clone in interface DataObject

Specified by:

clone in class AbstractDataObject

Returns:

copy of object

copyOf

public static MAPLCS_ClientID copyOf(MAPLCS_ClientID from)

Creates a new object of this type, cloning the values of common fields from the given object of any subclass of the same base type.

Parameters:

from - the object from which to copy

Returns:

MAPLCS_ClientID

getFieldAccessors

public static FieldAccessor[] getFieldAccessors()

Gets a new array of the accessors for fields of this type.

Returns:

FieldAccessor[]

getFieldsMap

public Map<String,Object> getFieldsMap(boolean withAbsents)

Gets a Map from field-name to field-value. For a field of primitive type, the field-value is boxed. For an absent optional field, the field-value is AbstractFieldsObject.FIELD_ABSENT. For an unitialised mandatory field, the field-value is AbstractFieldsObject.FIELD_UNINITIALISED.

Specified by:

getFieldsMap in class AbstractFieldsObject

Parameters:

withAbsents - whether to put absent optional fields into Map

Returns:

Map from field-name to field-value

getLcsAPN

public AccessPointName getLcsAPN()

Gets the value of the field lcsAPN.

Returns:

value of field lcsAPN, or null if not present

getLcsClientDialedByMS

public AddressString getLcsClientDialedByMS()

Gets the value of the field lcsClientDialedByMS.

Returns:

value of field lcsClientDialedByMS, or null if not present

getLcsClientExternalID

public MAPLCSClientExternalID getLcsClientExternalID()

Gets the value of the field lcsClientExternalID.

Returns:

value of field lcsClientExternalID, or null if not present

getLcsClientInternalID

public MAPLCSClientInternalID getLcsClientInternalID()

Gets the value of the field lcsClientInternalID.

Returns:

value of field lcsClientInternalID, or null if not present

getLcsClientName

public MAPLCSClientName getLcsClientName()

Gets the value of the field lcsClientName.

Returns:

value of field lcsClientName, or null if not present

getLcsClientType

public MAPLCSClientType getLcsClientType()

Gets the value of the field lcsClientType.

Returns:

value of field lcsClientType, or null if not present

getLcsRequestorID

public MAPLCSRequestorID getLcsRequestorID()

Gets the value of the field lcsRequestorID.

Returns:

value of field lcsRequestorID, or null if not present

hasLcsAPN

public boolean hasLcsAPN()

Tests whether the field lcsAPN has a value.

Returns:

whether the field lcsAPN has a value

hasLcsClientDialedByMS

public boolean hasLcsClientDialedByMS()

Tests whether the field lcsClientDialedByMS has a value.

Returns:

whether the field lcsClientDialedByMS has a value

hasLcsClientExternalID

public boolean hasLcsClientExternalID()

Tests whether the field lcsClientExternalID has a value.

Returns:

whether the field lcsClientExternalID has a value

hasLcsClientInternalID

public boolean hasLcsClientInternalID()

Tests whether the field lcsClientInternalID has a value.

Returns:

whether the field lcsClientInternalID has a value

hasLcsClientName

public boolean hasLcsClientName()

Tests whether the field lcsClientName has a value.

Returns:

whether the field lcsClientName has a value

hasLcsClientType

public boolean hasLcsClientType()

Tests whether the field lcsClientType has a value.

Returns:

whether the field lcsClientType has a value

hasLcsRequestorID

public boolean hasLcsRequestorID()

Tests whether the field lcsRequestorID has a value.

Returns:

whether the field lcsRequestorID has a value

setLcsAPN

public MAPLCS_ClientID setLcsAPN(AccessPointName value)
                          throws IllegalStateException

Sets the value of the field lcsAPN. If null, marks the field as absent.

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setLcsClientDialedByMS

public MAPLCS_ClientID setLcsClientDialedByMS(AddressString value)
                                       throws IllegalStateException

Sets the value of the field lcsClientDialedByMS. If null, marks the field as absent.

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setLcsClientExternalID

public MAPLCS_ClientID setLcsClientExternalID(MAPLCSClientExternalID value)
                                       throws IllegalStateException

Sets the value of the field lcsClientExternalID. If null, marks the field as absent.

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setLcsClientInternalID

public MAPLCS_ClientID setLcsClientInternalID(MAPLCSClientInternalID value)
                                       throws IllegalStateException

Sets the value of the field lcsClientInternalID. If null, marks the field as absent.

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setLcsClientName

public MAPLCS_ClientID setLcsClientName(MAPLCSClientName value)
                                 throws IllegalStateException

Sets the value of the field lcsClientName. If null, marks the field as absent.

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setLcsClientType

public MAPLCS_ClientID setLcsClientType(MAPLCSClientType value)
                                 throws IllegalStateException

Sets the value of the field lcsClientType.

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setLcsRequestorID

public MAPLCS_ClientID setLcsRequestorID(MAPLCSRequestorID value)
                                  throws IllegalStateException

Sets the value of the field lcsRequestorID. If null, marks the field as absent.

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setReadOnly

public void setReadOnly()

Sets this and all its fields to be immutable.

Specified by:

setReadOnly in interface DataObject

Overrides:

setReadOnly in class AbstractDataObject