com.opencloud.slee.resources.cgin.cap_v3

Class CAP3InitialDPGPRSArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CAP3InitialDPGPRSArg

All Implemented Interfaces:

DataObject, Serializable

public class CAP3InitialDPGPRSArg
extends AbstractFieldsObject

API for CAP-gprsSSF-gsmSCF-ops-args.InitialDPGPRSArg. Generated from the following ASN.1 type definition.

 InitialDPGPRSArg ::=
     SEQUENCE {
         serviceKey              ServiceKey,
         gPRSEventType           GPRSEventType,
         mSISDN                  ISDN-AddressString,
         iMSI                    IMSI,
         timeAndTimeZone         TimeAndTimezone,
         gPRSMSClass             GPRSMSClass OPTIONAL,
         endUserAddress          EndUserAddress OPTIONAL,
         qualityOfService        QualityOfService OPTIONAL,
         accessPointName         AccessPointName OPTIONAL,
         routeingAreaIdentity    RAIdentity OPTIONAL,
         chargingID              GPRSChargingID OPTIONAL,
         sGSNCapabilities        SGSNCapabilities OPTIONAL,
         locationInformationGPRS LocationInformationGPRS OPTIONAL,
         pDPInitiationType       PDPInitiationType OPTIONAL,
         extensions              Extensions OPTIONAL,
         ...
         gGSNAddress             GSN-Address OPTIONAL,
         secondaryPDP-context    NULL OPTIONAL
     }
 

Used as argument type by CAP3Operations.initialDPGPRS.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CAP3InitialDPGPRSArg	clone() Constructs a copy of this object and everything reachable from it.
static CAP3InitialDPGPRSArg	copyOf(CAP3InitialDPGPRSArg 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.
AccessPointName	getAccessPointName() Gets the value of the field accessPointName.
byte[]	getChargingID() Gets the value of the field chargingID.
CAP3EndUserAddress	getEndUserAddress() Gets the value of the field endUserAddress.
CAP1ExtensionField[]	getExtensions() Gets the value of the field extensions.
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.
GSNAddress	getGGSNAddress() Gets the value of the field gGSNAddress.
CAP3GPRSEventType	getGPRSEventType() Gets the value of the field gPRSEventType.
CAP3GPRSMSClass	getGPRSMSClass() Gets the value of the field gPRSMSClass.
IMSIAddress	getIMSI() Gets the value of the field iMSI.
CAP3LocationInformationGPRS	getLocationInformationGPRS() Gets the value of the field locationInformationGPRS.
AddressString	getMSISDN() Gets the value of the field mSISDN.
CAP3PDPInitiationType	getPDPInitiationType() Gets the value of the field pDPInitiationType.
CAP3QualityOfService	getQualityOfService() Gets the value of the field qualityOfService.
byte[]	getRouteingAreaIdentity() Gets the value of the field routeingAreaIdentity.
int	getServiceKey() Gets the value of the field serviceKey.
byte[]	getSGSNCapabilities() Gets the value of the field sGSNCapabilities.
TimeAndTimezone	getTimeAndTimeZone() Gets the value of the field timeAndTimeZone.
boolean	hasAccessPointName() Tests whether the field accessPointName has a value.
boolean	hasChargingID() Tests whether the field chargingID has a value.
boolean	hasEndUserAddress() Tests whether the field endUserAddress has a value.
boolean	hasExtensions() Tests whether the field extensions has a value.
boolean	hasGGSNAddress() Tests whether the field gGSNAddress has a value.
boolean	hasGPRSEventType() Tests whether the field gPRSEventType has a value.
boolean	hasGPRSMSClass() Tests whether the field gPRSMSClass has a value.
boolean	hasIMSI() Tests whether the field iMSI has a value.
boolean	hasLocationInformationGPRS() Tests whether the field locationInformationGPRS has a value.
boolean	hasMSISDN() Tests whether the field mSISDN has a value.
boolean	hasPDPInitiationType() Tests whether the field pDPInitiationType has a value.
boolean	hasQualityOfService() Tests whether the field qualityOfService has a value.
boolean	hasRouteingAreaIdentity() Tests whether the field routeingAreaIdentity has a value.
boolean	hasSecondaryPDP_context() Tests whether the field secondaryPDP-context is present.
boolean	hasServiceKey() Tests whether the field serviceKey has a value.
boolean	hasSGSNCapabilities() Tests whether the field sGSNCapabilities has a value.
boolean	hasTimeAndTimeZone() Tests whether the field timeAndTimeZone has a value.
CAP3InitialDPGPRSArg	setAccessPointName(AccessPointName value) Sets the value of the field accessPointName.
CAP3InitialDPGPRSArg	setChargingID(byte[] value) Sets the value of the field chargingID.
CAP3InitialDPGPRSArg	setEndUserAddress(CAP3EndUserAddress value) Sets the value of the field endUserAddress.
CAP3InitialDPGPRSArg	setExtensions(CAP1ExtensionField[] value) Sets the value of the field extensions.
CAP3InitialDPGPRSArg	setGGSNAddress(GSNAddress value) Sets the value of the field gGSNAddress.
CAP3InitialDPGPRSArg	setGPRSEventType(CAP3GPRSEventType value) Sets the value of the field gPRSEventType.
CAP3InitialDPGPRSArg	setGPRSMSClass(CAP3GPRSMSClass value) Sets the value of the field gPRSMSClass.
CAP3InitialDPGPRSArg	setIMSI(IMSIAddress value) Sets the value of the field iMSI.
CAP3InitialDPGPRSArg	setLocationInformationGPRS(CAP3LocationInformationGPRS value) Sets the value of the field locationInformationGPRS.
CAP3InitialDPGPRSArg	setMSISDN(AddressString value) Sets the value of the field mSISDN.
CAP3InitialDPGPRSArg	setPDPInitiationType(CAP3PDPInitiationType value) Sets the value of the field pDPInitiationType.
CAP3InitialDPGPRSArg	setQualityOfService(CAP3QualityOfService value) Sets the value of the field qualityOfService.
void	setReadOnly() Sets this and all its fields to be immutable.
CAP3InitialDPGPRSArg	setRouteingAreaIdentity(byte[] value) Sets the value of the field routeingAreaIdentity.
CAP3InitialDPGPRSArg	setSecondaryPDP_contextPresent(boolean flag) Sets the presence or absence of the optional field secondaryPDP-context.
CAP3InitialDPGPRSArg	setServiceKey(int value) Sets the value of the field serviceKey and marks the field as present.
CAP3InitialDPGPRSArg	setSGSNCapabilities(byte[] value) Sets the value of the field sGSNCapabilities.
CAP3InitialDPGPRSArg	setTimeAndTimeZone(TimeAndTimezone value) Sets the value of the field timeAndTimeZone.

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

CAP3InitialDPGPRSArg

public CAP3InitialDPGPRSArg()

Constructs an object with uninitialised state.

Method Detail

clone

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

CAP3InitialDPGPRSArg

getAccessPointName

public AccessPointName getAccessPointName()

Gets the value of the field accessPointName.

Returns:

value of field accessPointName, or null if not present

getChargingID

public byte[] getChargingID()

Gets the value of the field chargingID.

Returns:

value of field chargingID, or null if not present

getEndUserAddress

public CAP3EndUserAddress getEndUserAddress()

Gets the value of the field endUserAddress.

Returns:

value of field endUserAddress, or null if not present

getExtensions

public CAP1ExtensionField[] getExtensions()

Gets the value of the field extensions.

Returns:

value of field extensions, 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

getGGSNAddress

public GSNAddress getGGSNAddress()

Gets the value of the field gGSNAddress.

Returns:

value of field gGSNAddress, or null if not present

getGPRSEventType

public CAP3GPRSEventType getGPRSEventType()

Gets the value of the field gPRSEventType.

Returns:

value of field gPRSEventType, or null if not present

getGPRSMSClass

public CAP3GPRSMSClass getGPRSMSClass()

Gets the value of the field gPRSMSClass.

Returns:

value of field gPRSMSClass, or null if not present

getIMSI

public IMSIAddress getIMSI()

Gets the value of the field iMSI.

Returns:

value of field iMSI, or null if not present

getLocationInformationGPRS

public CAP3LocationInformationGPRS getLocationInformationGPRS()

Gets the value of the field locationInformationGPRS.

Returns:

value of field locationInformationGPRS, or null if not present

getMSISDN

public AddressString getMSISDN()

Gets the value of the field mSISDN.

Returns:

value of field mSISDN, or null if not present

getPDPInitiationType

public CAP3PDPInitiationType getPDPInitiationType()

Gets the value of the field pDPInitiationType.

Returns:

value of field pDPInitiationType, or null if not present

getQualityOfService

public CAP3QualityOfService getQualityOfService()

Gets the value of the field qualityOfService.

Returns:

value of field qualityOfService, 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

getSGSNCapabilities

public byte[] getSGSNCapabilities()

Gets the value of the field sGSNCapabilities.

Returns:

value of field sGSNCapabilities, or null if not present

getServiceKey

public int getServiceKey()

Gets the value of the field serviceKey.

Returns:

value of field serviceKey

getTimeAndTimeZone

public TimeAndTimezone getTimeAndTimeZone()

Gets the value of the field timeAndTimeZone.

Returns:

value of field timeAndTimeZone, or null if not present

hasAccessPointName

public boolean hasAccessPointName()

Tests whether the field accessPointName has a value.

Returns:

whether the field accessPointName has a value

hasChargingID

public boolean hasChargingID()

Tests whether the field chargingID has a value.

Returns:

whether the field chargingID has a value

hasEndUserAddress

public boolean hasEndUserAddress()

Tests whether the field endUserAddress has a value.

Returns:

whether the field endUserAddress has a value

hasExtensions

public boolean hasExtensions()

Tests whether the field extensions has a value.

Returns:

whether the field extensions has a value

hasGGSNAddress

public boolean hasGGSNAddress()

Tests whether the field gGSNAddress has a value.

Returns:

whether the field gGSNAddress has a value

hasGPRSEventType

public boolean hasGPRSEventType()

Tests whether the field gPRSEventType has a value.

Returns:

whether the field gPRSEventType has a value

hasGPRSMSClass

public boolean hasGPRSMSClass()

Tests whether the field gPRSMSClass has a value.

Returns:

whether the field gPRSMSClass has a value

hasIMSI

public boolean hasIMSI()

Tests whether the field iMSI has a value.

Returns:

whether the field iMSI has a value

hasLocationInformationGPRS

public boolean hasLocationInformationGPRS()

Tests whether the field locationInformationGPRS has a value.

Returns:

whether the field locationInformationGPRS has a value

hasMSISDN

public boolean hasMSISDN()

Tests whether the field mSISDN has a value.

Returns:

whether the field mSISDN has a value

hasPDPInitiationType

public boolean hasPDPInitiationType()

Tests whether the field pDPInitiationType has a value.

Returns:

whether the field pDPInitiationType has a value

hasQualityOfService

public boolean hasQualityOfService()

Tests whether the field qualityOfService has a value.

Returns:

whether the field qualityOfService has a value

hasRouteingAreaIdentity

public boolean hasRouteingAreaIdentity()

Tests whether the field routeingAreaIdentity has a value.

Returns:

whether the field routeingAreaIdentity has a value

hasSGSNCapabilities

public boolean hasSGSNCapabilities()

Tests whether the field sGSNCapabilities has a value.

Returns:

whether the field sGSNCapabilities has a value

hasSecondaryPDP_context

public boolean hasSecondaryPDP_context()

Tests whether the field secondaryPDP-context is present.

Returns:

whether the field secondaryPDP-context is present

hasServiceKey

public boolean hasServiceKey()

Tests whether the field serviceKey has a value.

Returns:

whether the field serviceKey has a value

hasTimeAndTimeZone

public boolean hasTimeAndTimeZone()

Tests whether the field timeAndTimeZone has a value.

Returns:

whether the field timeAndTimeZone has a value

setAccessPointName

public CAP3InitialDPGPRSArg setAccessPointName(AccessPointName value)
                                        throws IllegalStateException

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

setChargingID

public CAP3InitialDPGPRSArg setChargingID(byte[] value)
                                   throws IllegalStateException

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

setEndUserAddress

public CAP3InitialDPGPRSArg setEndUserAddress(CAP3EndUserAddress value)
                                       throws IllegalStateException

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

setExtensions

public CAP3InitialDPGPRSArg setExtensions(CAP1ExtensionField[] value)
                                   throws IllegalStateException

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

setGGSNAddress

public CAP3InitialDPGPRSArg setGGSNAddress(GSNAddress value)
                                    throws IllegalStateException

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

setGPRSEventType

public CAP3InitialDPGPRSArg setGPRSEventType(CAP3GPRSEventType value)
                                      throws IllegalStateException

Sets the value of the field gPRSEventType.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setGPRSMSClass

public CAP3InitialDPGPRSArg setGPRSMSClass(CAP3GPRSMSClass value)
                                    throws IllegalStateException

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

setIMSI

public CAP3InitialDPGPRSArg setIMSI(IMSIAddress value)
                             throws IllegalStateException

Sets the value of the field iMSI.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setLocationInformationGPRS

public CAP3InitialDPGPRSArg setLocationInformationGPRS(CAP3LocationInformationGPRS value)
                                                throws IllegalStateException

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

setMSISDN

public CAP3InitialDPGPRSArg setMSISDN(AddressString value)
                               throws IllegalStateException

Sets the value of the field mSISDN.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setPDPInitiationType

public CAP3InitialDPGPRSArg setPDPInitiationType(CAP3PDPInitiationType value)
                                          throws IllegalStateException

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

setQualityOfService

public CAP3InitialDPGPRSArg setQualityOfService(CAP3QualityOfService value)
                                         throws IllegalStateException

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

setSGSNCapabilities

public CAP3InitialDPGPRSArg setSGSNCapabilities(byte[] value)
                                         throws IllegalStateException

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

setSecondaryPDP_contextPresent

public CAP3InitialDPGPRSArg setSecondaryPDP_contextPresent(boolean flag)
                                                    throws IllegalStateException

Sets the presence or absence of the optional field secondaryPDP-context.

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

setServiceKey

public CAP3InitialDPGPRSArg setServiceKey(int value)
                                   throws IllegalStateException

Sets the value of the field serviceKey and marks the field as present.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setTimeAndTimeZone

public CAP3InitialDPGPRSArg setTimeAndTimeZone(TimeAndTimezone value)
                                        throws IllegalStateException

Sets the value of the field timeAndTimeZone.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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