com.opencloud.slee.resources.cgin.cap_v3

Class CAP3LocationInformationGPRS

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CAP3LocationInformationGPRS

All Implemented Interfaces:

DataObject, Serializable

Direct Known Subclasses:

CAP4LocationInformationGPRS

public class CAP3LocationInformationGPRS
extends AbstractFieldsObject

API for CAP-datatypes.LocationInformationGPRS. Generated from the following ASN.1 type definition.

 LocationInformationGPRS ::=
     SEQUENCE {
         cellGlobalIdOrServiceAreaIdOrLAI OCTET STRING (SIZE (5..7)) OPTIONAL,
         routeingAreaIdentity             RAIdentity OPTIONAL,
         geographicalInformation          GeographicalInformation OPTIONAL,
         sgsn-Number                      ISDN-AddressString OPTIONAL,
         selectedLSAIdentity              LSAIdentity OPTIONAL,
         extensionContainer               ExtensionContainer OPTIONAL,
         ...
         sai-Present                      NULL OPTIONAL
     }
 

Used as field type by CAP3InitialDPGPRSArg.

Used as field type by CAP3GPRSEventSpecificInformation.AttachChangeOfPositionSpecificInformation.

Used as field type by CAP3GPRSEventSpecificInformation.Pdp_ContextchangeOfPositionSpecificInformation.

Used as field type by CAP3GPRSEventSpecificInformation.PDPContextEstablishmentSpecificInformation.

Used as field type by CAP3GPRSEventSpecificInformation.PDPContextEstablishmentAcknowledgementSpecificInformation.

Used as field type by CAP3InitialDPSMSArg.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CAP3LocationInformationGPRS	clone() Constructs a copy of this object and everything reachable from it.
static CAP3LocationInformationGPRS	copyOf(CAP3LocationInformationGPRS 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.
byte[]	getCellGlobalIdOrServiceAreaIdOrLAI() Gets the value of the field cellGlobalIdOrServiceAreaIdOrLAI.
MAPExtensionContainer	getExtensionContainer() Gets the value of the field extensionContainer.
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.
byte[]	getGeographicalInformation() Gets the value of the field geographicalInformation.
byte[]	getRouteingAreaIdentity() Gets the value of the field routeingAreaIdentity.
LocalisedServiceAreaId	getSelectedLSAIdentity() Gets the value of the field selectedLSAIdentity.
AddressString	getSgsn_Number() Gets the value of the field sgsn-Number.
boolean	hasCellGlobalIdOrServiceAreaIdOrLAI() Tests whether the field cellGlobalIdOrServiceAreaIdOrLAI has a value.
boolean	hasExtensionContainer() Tests whether the field extensionContainer has a value.
boolean	hasGeographicalInformation() Tests whether the field geographicalInformation has a value.
boolean	hasRouteingAreaIdentity() Tests whether the field routeingAreaIdentity has a value.
boolean	hasSai_Present() Tests whether the field sai-Present is present.
boolean	hasSelectedLSAIdentity() Tests whether the field selectedLSAIdentity has a value.
boolean	hasSgsn_Number() Tests whether the field sgsn-Number has a value.
CAP3LocationInformationGPRS	setCellGlobalIdOrServiceAreaIdOrLAI(byte[] value) Sets the value of the field cellGlobalIdOrServiceAreaIdOrLAI.
CAP3LocationInformationGPRS	setExtensionContainer(MAPExtensionContainer value) Sets the value of the field extensionContainer.
CAP3LocationInformationGPRS	setGeographicalInformation(byte[] value) Sets the value of the field geographicalInformation.
void	setReadOnly() Sets this and all its fields to be immutable.
CAP3LocationInformationGPRS	setRouteingAreaIdentity(byte[] value) Sets the value of the field routeingAreaIdentity.
CAP3LocationInformationGPRS	setSai_PresentPresent(boolean flag) Sets the presence or absence of the optional field sai-Present.
CAP3LocationInformationGPRS	setSelectedLSAIdentity(LocalisedServiceAreaId value) Sets the value of the field selectedLSAIdentity.
CAP3LocationInformationGPRS	setSgsn_Number(AddressString value) Sets the value of the field sgsn-Number.

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

CAP3LocationInformationGPRS

public CAP3LocationInformationGPRS()

Constructs an object with uninitialised state.

Method Detail

clone

public CAP3LocationInformationGPRS 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 CAP3LocationInformationGPRS copyOf(CAP3LocationInformationGPRS 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:

CAP3LocationInformationGPRS

getCellGlobalIdOrServiceAreaIdOrLAI

public byte[] getCellGlobalIdOrServiceAreaIdOrLAI()

Gets the value of the field cellGlobalIdOrServiceAreaIdOrLAI.

Returns:

value of field cellGlobalIdOrServiceAreaIdOrLAI, or null if not present

getExtensionContainer

public MAPExtensionContainer getExtensionContainer()

Gets the value of the field extensionContainer.

Returns:

value of field extensionContainer, or null if not present

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

getGeographicalInformation

public byte[] getGeographicalInformation()

Gets the value of the field geographicalInformation.

Returns:

value of field geographicalInformation, or null if not present

getRouteingAreaIdentity

public byte[] getRouteingAreaIdentity()

Gets the value of the field routeingAreaIdentity.

Returns:

value of field routeingAreaIdentity, or null if not present

getSelectedLSAIdentity

public LocalisedServiceAreaId getSelectedLSAIdentity()

Gets the value of the field selectedLSAIdentity.

Returns:

value of field selectedLSAIdentity, or null if not present

getSgsn_Number

public AddressString getSgsn_Number()

Gets the value of the field sgsn-Number.

Returns:

value of field sgsn-Number, or null if not present

hasCellGlobalIdOrServiceAreaIdOrLAI

public boolean hasCellGlobalIdOrServiceAreaIdOrLAI()

Tests whether the field cellGlobalIdOrServiceAreaIdOrLAI has a value.

Returns:

whether the field cellGlobalIdOrServiceAreaIdOrLAI has a value

hasExtensionContainer

public boolean hasExtensionContainer()

Tests whether the field extensionContainer has a value.

Returns:

whether the field extensionContainer has a value

hasGeographicalInformation

public boolean hasGeographicalInformation()

Tests whether the field geographicalInformation has a value.

Returns:

whether the field geographicalInformation has a value

hasRouteingAreaIdentity

public boolean hasRouteingAreaIdentity()

Tests whether the field routeingAreaIdentity has a value.

Returns:

whether the field routeingAreaIdentity has a value

hasSai_Present

public boolean hasSai_Present()

Tests whether the field sai-Present is present.

Returns:

whether the field sai-Present is present

hasSelectedLSAIdentity

public boolean hasSelectedLSAIdentity()

Tests whether the field selectedLSAIdentity has a value.

Returns:

whether the field selectedLSAIdentity has a value

hasSgsn_Number

public boolean hasSgsn_Number()

Tests whether the field sgsn-Number has a value.

Returns:

whether the field sgsn-Number has a value

setCellGlobalIdOrServiceAreaIdOrLAI

public CAP3LocationInformationGPRS setCellGlobalIdOrServiceAreaIdOrLAI(byte[] value)
                                                                throws IllegalStateException

Sets the value of the field cellGlobalIdOrServiceAreaIdOrLAI. 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

setExtensionContainer

public CAP3LocationInformationGPRS setExtensionContainer(MAPExtensionContainer value)
                                                  throws IllegalStateException

Sets the value of the field extensionContainer. 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

setGeographicalInformation

public CAP3LocationInformationGPRS setGeographicalInformation(byte[] value)
                                                       throws IllegalStateException

Sets the value of the field geographicalInformation. 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

setRouteingAreaIdentity

public CAP3LocationInformationGPRS setRouteingAreaIdentity(byte[] value)
                                                    throws IllegalStateException

Sets the value of the field routeingAreaIdentity. 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

setSai_PresentPresent

public CAP3LocationInformationGPRS setSai_PresentPresent(boolean flag)
                                                  throws IllegalStateException

Sets the presence or absence of the optional field sai-Present.

Parameters:

flag - either true if the field should be marked as present or false if the field should be marked as absent

Returns:

this

Throws:

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

setSelectedLSAIdentity

public CAP3LocationInformationGPRS setSelectedLSAIdentity(LocalisedServiceAreaId value)
                                                   throws IllegalStateException

Sets the value of the field selectedLSAIdentity. 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

setSgsn_Number

public CAP3LocationInformationGPRS setSgsn_Number(AddressString value)
                                           throws IllegalStateException

Sets the value of the field sgsn-Number. 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