Package com.opencloud.slee.resources.cgin.cap_v4

Class CAP4LocationInformationGPRS

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CAP3LocationInformationGPRS

CAP4LocationInformationGPRS

All Implemented Interfaces:

DataObject, Serializable

public class CAP4LocationInformationGPRS
extends CAP3LocationInformationGPRS

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

 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,
         userCSGInformation               UserCSGInformation OPTIONAL
     }
 CAP-datatypes {
     LocationInformationGPRS {
         @parentType com.opencloud.slee.resources.cgin.cap_v3.CAP3LocationInformationGPRS
     }
 }
 

Used as field type by CAP4InitialDPSMSArg.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

Constructor	Description
CAP4LocationInformationGPRS()	Constructs an object with uninitialised state.

Method Summary

Modifier and Type	Method	Description
CAP4LocationInformationGPRS	clone()	Constructs a copy of this object and everything reachable from it.
static CAP4LocationInformationGPRS	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.
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.
MAPUserCSGInformation	getUserCSGInformation()	Gets the value of the field userCSGInformation.
boolean	hasUserCSGInformation()	Tests whether the field userCSGInformation has a value.
CAP4LocationInformationGPRS	setCellGlobalIdOrServiceAreaIdOrLAI(byte[] value)	Sets the value of the field cellGlobalIdOrServiceAreaIdOrLAI.
CAP4LocationInformationGPRS	setExtensionContainer(MAPExtensionContainer value)	Sets the value of the field extensionContainer.
CAP4LocationInformationGPRS	setGeographicalInformation(byte[] value)	Sets the value of the field geographicalInformation.
void	setReadOnly()	Sets this and all its fields to be immutable.
CAP4LocationInformationGPRS	setRouteingAreaIdentity(byte[] value)	Sets the value of the field routeingAreaIdentity.
CAP4LocationInformationGPRS	setSai_PresentPresent(boolean flag)	Sets the presence or absence of the optional field sai-Present.
CAP4LocationInformationGPRS	setSelectedLSAIdentity(LocalisedServiceAreaId value)	Sets the value of the field selectedLSAIdentity.
CAP4LocationInformationGPRS	setSgsn_Number(AddressString value)	Sets the value of the field sgsn-Number.
CAP4LocationInformationGPRS	setUserCSGInformation(MAPUserCSGInformation value)	Sets the value of the field userCSGInformation.

Methods inherited from class com.opencloud.slee.resources.cgin.cap_v3.CAP3LocationInformationGPRS

getCellGlobalIdOrServiceAreaIdOrLAI, getExtensionContainer, getGeographicalInformation, getRouteingAreaIdentity, getSelectedLSAIdentity, getSgsn_Number, hasCellGlobalIdOrServiceAreaIdOrLAI, hasExtensionContainer, hasGeographicalInformation, hasRouteingAreaIdentity, hasSai_Present, hasSelectedLSAIdentity, hasSgsn_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

CAP4LocationInformationGPRS

public CAP4LocationInformationGPRS()

Constructs an object with uninitialised state.

Method Detail

clone

public CAP4LocationInformationGPRS clone()

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

Specified by:

clone in interface DataObject

Overrides:

clone in class CAP3LocationInformationGPRS

Returns:

copy of object

copyOf

public static CAP4LocationInformationGPRS 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:

CAP4LocationInformationGPRS

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.

Overrides:

getFieldsMap in class CAP3LocationInformationGPRS

Parameters:

withAbsents - whether to put absent optional fields into Map

Returns:

Map from field-name to field-value

getUserCSGInformation

public MAPUserCSGInformation getUserCSGInformation()

Gets the value of the field userCSGInformation.

Returns:

value of field userCSGInformation, or null if not present

hasUserCSGInformation

public boolean hasUserCSGInformation()

Tests whether the field userCSGInformation has a value.

Returns:

whether the field userCSGInformation has a value

setCellGlobalIdOrServiceAreaIdOrLAI

public CAP4LocationInformationGPRS setCellGlobalIdOrServiceAreaIdOrLAI(byte[] value)
                                                                throws IllegalStateException

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

Overrides:

setCellGlobalIdOrServiceAreaIdOrLAI in class CAP3LocationInformationGPRS

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setExtensionContainer

public CAP4LocationInformationGPRS setExtensionContainer(MAPExtensionContainer value)
                                                  throws IllegalStateException

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

Overrides:

setExtensionContainer in class CAP3LocationInformationGPRS

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setGeographicalInformation

public CAP4LocationInformationGPRS setGeographicalInformation(byte[] value)
                                                       throws IllegalStateException

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

Overrides:

setGeographicalInformation in class CAP3LocationInformationGPRS

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 CAP3LocationInformationGPRS

setRouteingAreaIdentity

public CAP4LocationInformationGPRS setRouteingAreaIdentity(byte[] value)
                                                    throws IllegalStateException

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

Overrides:

setRouteingAreaIdentity in class CAP3LocationInformationGPRS

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setSai_PresentPresent

public CAP4LocationInformationGPRS setSai_PresentPresent(boolean flag)
                                                  throws IllegalStateException

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

Overrides:

setSai_PresentPresent in class CAP3LocationInformationGPRS

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 CAP4LocationInformationGPRS setSelectedLSAIdentity(LocalisedServiceAreaId value)
                                                   throws IllegalStateException

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

Overrides:

setSelectedLSAIdentity in class CAP3LocationInformationGPRS

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setSgsn_Number

public CAP4LocationInformationGPRS setSgsn_Number(AddressString value)
                                           throws IllegalStateException

Sets the value of the field sgsn-Number. If null, marks the field as absent.

Overrides:

setSgsn_Number in class CAP3LocationInformationGPRS

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setUserCSGInformation

public CAP4LocationInformationGPRS setUserCSGInformation(MAPUserCSGInformation value)
                                                  throws IllegalStateException

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