Package com.opencloud.slee.resources.cgin.cap_v2

Class CAP2InitialDPArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CCInitialDPArg

CAP1InitialDPArg

CAP2InitialDPArg

All Implemented Interfaces:

DataObject, Serializable

Direct Known Subclasses:

CAP3InitialDPArg

public class CAP2InitialDPArg
extends CAP1InitialDPArg

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

 InitialDPArg ::=
     SEQUENCE {
         serviceKey                   ServiceKey,
         calledPartyNumber            CalledPartyNumber OPTIONAL,
         callingPartyNumber           CallingPartyNumber OPTIONAL,
         callingPartysCategory        CallingPartysCategory OPTIONAL,
         iPSSPCapabilities            IPSSPCapabilities OPTIONAL,
         locationNumber               LocationNumber OPTIONAL,
         originalCalledPartyID        OriginalCalledPartyID OPTIONAL,
         extensions                   SEQUENCE (SIZE (1..10)) OF ExtensionField OPTIONAL,
         highLayerCompatibility       HighLayerCompatibility OPTIONAL,
         additionalCallingPartyNumber AdditionalCallingPartyNumber OPTIONAL,
         bearerCapability             BearerCapability OPTIONAL,
         eventTypeBCSM                EventTypeBCSM OPTIONAL,
         redirectingPartyID           RedirectingPartyID OPTIONAL,
         redirectionInformation       RedirectionInformation OPTIONAL,
         iMSI                         IMSI OPTIONAL,
         subscriberState              SubscriberState OPTIONAL,
         locationInformation          LocationInformation OPTIONAL,
         ext-basicServiceCode         Ext-BasicServiceCode OPTIONAL,
         callReferenceNumber          CallReferenceNumber OPTIONAL,
         mscAddress                   ISDN-AddressString OPTIONAL,
         calledPartyBCDNumber         CalledPartyBCDNumber OPTIONAL,
         timeAndTimezone              TimeAndTimezone OPTIONAL,
         gsm-ForwardingPending        NULL OPTIONAL,
         ...
         initialDPArgExtension        InitialDPArgExtension OPTIONAL
     }
 CAP-DataTypes {
     InitialDPArg {
         @parentType com.opencloud.slee.resources.cgin.cap_v1.CAP1InitialDPArg
     }
 }
 

Used as argument type by CAP2Operations.initialDP.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
CAP2InitialDPArg	clone()	Constructs a copy of this object and everything reachable from it.
static CAP2InitialDPArg	copyOf(CCInitialDPArg 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.
CAP2InitialDPArgExtension	getInitialDPArgExtension()	Gets the value of the field initialDPArgExtension.
TimeAndTimezone	getTimeAndTimezone()	Gets the value of the field timeAndTimezone.
boolean	hasGsm_ForwardingPending()	Tests whether the field gsm-ForwardingPending is present.
boolean	hasInitialDPArgExtension()	Tests whether the field initialDPArgExtension has a value.
boolean	hasTimeAndTimezone()	Tests whether the field timeAndTimezone has a value.
CAP2InitialDPArg	setAdditionalCallingPartyNumber(GenericNumber value)	Sets the value of the field additionalCallingPartyNumber.
CAP2InitialDPArg	setBearerCapability(CCBearerCapability value)	Sets the value of the field bearerCapability.
CAP2InitialDPArg	setCalledPartyBCDNumber(CalledPartyBCDNumber value)	Sets the value of the field calledPartyBCDNumber.
CAP2InitialDPArg	setCalledPartyNumber(CalledPartyNumber value)	Sets the value of the field calledPartyNumber.
CAP2InitialDPArg	setCallingPartyNumber(CallingPartyNumber value)	Sets the value of the field callingPartyNumber.
CAP2InitialDPArg	setCallingPartysCategory(CallingPartysCategory value)	Sets the value of the field callingPartysCategory.
CAP2InitialDPArg	setCallReferenceNumber(byte[] value)	Sets the value of the field callReferenceNumber.
CAP2InitialDPArg	setEventTypeBCSM(CCEventTypeBCSM value)	Sets the value of the field eventTypeBCSM.
CAP2InitialDPArg	setExt_basicServiceCode(MAPExt_BasicServiceCode value)	Sets the value of the field ext-basicServiceCode.
CAP2InitialDPArg	setExtensions(CAP1ExtensionField[] value)	Sets the value of the field extensions.
CAP2InitialDPArg	setGsm_ForwardingPendingPresent(boolean flag)	Sets the presence or absence of the optional field gsm-ForwardingPending.
CAP2InitialDPArg	setHighLayerCompatibility(HighLayerCompatibility value)	Sets the value of the field highLayerCompatibility.
CAP2InitialDPArg	setIMSI(IMSIAddress value)	Sets the value of the field iMSI.
CAP2InitialDPArg	setInitialDPArgExtension(CAP2InitialDPArgExtension value)	Sets the value of the field initialDPArgExtension.
CAP2InitialDPArg	setIPSSPCapabilities(CAP2IPSSPCapabilities value)	Sets the value of the field iPSSPCapabilities.
CAP2InitialDPArg	setLocationInformation(MAPLocationInformation value)	Sets the value of the field locationInformation.
CAP2InitialDPArg	setLocationNumber(LocationNumber value)	Sets the value of the field locationNumber.
CAP2InitialDPArg	setMscAddress(AddressString value)	Sets the value of the field mscAddress.
CAP2InitialDPArg	setOriginalCalledPartyID(OriginalCalledNumber value)	Sets the value of the field originalCalledPartyID.
void	setReadOnly()	Sets this and all its fields to be immutable.
CAP2InitialDPArg	setRedirectingPartyID(RedirectingPartyNumber value)	Sets the value of the field redirectingPartyID.
CAP2InitialDPArg	setRedirectionInformation(RedirectionInformation value)	Sets the value of the field redirectionInformation.
CAP2InitialDPArg	setServiceKey(int value)	Sets the value of the field serviceKey.
CAP2InitialDPArg	setSubscriberState(MAPSubscriberState value)	Sets the value of the field subscriberState.
CAP2InitialDPArg	setTimeAndTimezone(TimeAndTimezone value)	Sets the value of the field timeAndTimezone.

Methods inherited from class com.opencloud.slee.resources.cgin.cap_v1.CAP1InitialDPArg

getCalledPartyBCDNumber, getCallReferenceNumber, getExt_basicServiceCode, getExtensions, getIMSI, getLocationInformation, getMscAddress, getSubscriberState, hasCalledPartyBCDNumber, hasCallReferenceNumber, hasExt_basicServiceCode, hasExtensions, hasIMSI, hasLocationInformation, hasMscAddress, hasSubscriberState

Methods inherited from class com.opencloud.slee.resources.cgin.callcontrol.CCInitialDPArg

getAdditionalCallingPartyNumber, getBearerCapability, getCalledPartyNumber, getCallingPartyNumber, getCallingPartysCategory, getEventTypeBCSM, getHighLayerCompatibility, getIPSSPCapabilities, getLocationNumber, getOriginalCalledPartyID, getRedirectingPartyID, getRedirectionInformation, getServiceKey, hasAdditionalCallingPartyNumber, hasBearerCapability, hasCalledPartyNumber, hasCallingPartyNumber, hasCallingPartysCategory, hasEventTypeBCSM, hasHighLayerCompatibility, hasIPSSPCapabilities, hasLocationNumber, hasOriginalCalledPartyID, hasRedirectingPartyID, hasRedirectionInformation, hasServiceKey, setIPSSPCapabilities

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

CAP2InitialDPArg

public CAP2InitialDPArg()

Constructs an object with uninitialised state.

Method Detail

clone

public CAP2InitialDPArg clone()

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

Specified by:

clone in interface DataObject

Overrides:

clone in class CAP1InitialDPArg

Returns:

copy of object

copyOf

public static CAP2InitialDPArg copyOf(CCInitialDPArg 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:

CAP2InitialDPArg

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 CAP1InitialDPArg

Parameters:

withAbsents - whether to put absent optional fields into Map

Returns:

Map from field-name to field-value

getInitialDPArgExtension

public CAP2InitialDPArgExtension getInitialDPArgExtension()

Gets the value of the field initialDPArgExtension.

Returns:

value of field initialDPArgExtension, or null if not present

getTimeAndTimezone

public TimeAndTimezone getTimeAndTimezone()

Gets the value of the field timeAndTimezone.

Returns:

value of field timeAndTimezone, or null if not present

hasGsm_ForwardingPending

public boolean hasGsm_ForwardingPending()

Tests whether the field gsm-ForwardingPending is present.

Returns:

whether the field gsm-ForwardingPending is present

hasInitialDPArgExtension

public boolean hasInitialDPArgExtension()

Tests whether the field initialDPArgExtension has a value.

Returns:

whether the field initialDPArgExtension has a value

hasTimeAndTimezone

public boolean hasTimeAndTimezone()

Tests whether the field timeAndTimezone has a value.

Returns:

whether the field timeAndTimezone has a value

setAdditionalCallingPartyNumber

public CAP2InitialDPArg setAdditionalCallingPartyNumber(GenericNumber value)
                                                 throws IllegalStateException

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

Overrides:

setAdditionalCallingPartyNumber in class CAP1InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setBearerCapability

public CAP2InitialDPArg setBearerCapability(CCBearerCapability value)
                                     throws IllegalStateException

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

Overrides:

setBearerCapability in class CAP1InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCallReferenceNumber

public CAP2InitialDPArg setCallReferenceNumber(byte[] value)
                                        throws IllegalStateException

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

Overrides:

setCallReferenceNumber in class CAP1InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCalledPartyBCDNumber

public CAP2InitialDPArg setCalledPartyBCDNumber(CalledPartyBCDNumber value)
                                         throws IllegalStateException

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

Overrides:

setCalledPartyBCDNumber in class CAP1InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCalledPartyNumber

public CAP2InitialDPArg setCalledPartyNumber(CalledPartyNumber value)
                                      throws IllegalStateException

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

Overrides:

setCalledPartyNumber in class CAP1InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCallingPartyNumber

public CAP2InitialDPArg setCallingPartyNumber(CallingPartyNumber value)
                                       throws IllegalStateException

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

Overrides:

setCallingPartyNumber in class CAP1InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCallingPartysCategory

public CAP2InitialDPArg setCallingPartysCategory(CallingPartysCategory value)
                                          throws IllegalStateException

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

Overrides:

setCallingPartysCategory in class CAP1InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setEventTypeBCSM

public CAP2InitialDPArg setEventTypeBCSM(CCEventTypeBCSM value)
                                  throws IllegalStateException

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

Overrides:

setEventTypeBCSM in class CAP1InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setExt_basicServiceCode

public CAP2InitialDPArg setExt_basicServiceCode(MAPExt_BasicServiceCode value)
                                         throws IllegalStateException

Sets the value of the field ext-basicServiceCode. If null, marks the field as absent.

Overrides:

setExt_basicServiceCode in class CAP1InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setExtensions

public CAP2InitialDPArg setExtensions(CAP1ExtensionField[] value)
                               throws IllegalStateException

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

Overrides:

setExtensions in class CAP1InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setGsm_ForwardingPendingPresent

public CAP2InitialDPArg setGsm_ForwardingPendingPresent(boolean flag)
                                                 throws IllegalStateException

Sets the presence or absence of the optional field gsm-ForwardingPending.

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

setHighLayerCompatibility

public CAP2InitialDPArg setHighLayerCompatibility(HighLayerCompatibility value)
                                           throws IllegalStateException

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

Overrides:

setHighLayerCompatibility in class CAP1InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setIMSI

public CAP2InitialDPArg setIMSI(IMSIAddress value)
                         throws IllegalStateException

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

Overrides:

setIMSI in class CAP1InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setIPSSPCapabilities

public CAP2InitialDPArg setIPSSPCapabilities(CAP2IPSSPCapabilities value)
                                      throws IllegalStateException

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

setInitialDPArgExtension

public CAP2InitialDPArg setInitialDPArgExtension(CAP2InitialDPArgExtension value)
                                          throws IllegalStateException

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

setLocationInformation

public CAP2InitialDPArg setLocationInformation(MAPLocationInformation value)
                                        throws IllegalStateException

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

Overrides:

setLocationInformation in class CAP1InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setLocationNumber

public CAP2InitialDPArg setLocationNumber(LocationNumber value)
                                   throws IllegalStateException

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

Overrides:

setLocationNumber in class CAP1InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setMscAddress

public CAP2InitialDPArg setMscAddress(AddressString value)
                               throws IllegalStateException

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

Overrides:

setMscAddress in class CAP1InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setOriginalCalledPartyID

public CAP2InitialDPArg setOriginalCalledPartyID(OriginalCalledNumber value)
                                          throws IllegalStateException

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

Overrides:

setOriginalCalledPartyID in class CAP1InitialDPArg

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 CAP1InitialDPArg

setRedirectingPartyID

public CAP2InitialDPArg setRedirectingPartyID(RedirectingPartyNumber value)
                                       throws IllegalStateException

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

Overrides:

setRedirectingPartyID in class CAP1InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setRedirectionInformation

public CAP2InitialDPArg setRedirectionInformation(RedirectionInformation value)
                                           throws IllegalStateException

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

Overrides:

setRedirectionInformation in class CAP1InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setServiceKey

public CAP2InitialDPArg setServiceKey(int value)
                               throws IllegalStateException

Sets the value of the field serviceKey.

Overrides:

setServiceKey in class CAP1InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setSubscriberState

public CAP2InitialDPArg setSubscriberState(MAPSubscriberState value)
                                    throws IllegalStateException

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

Overrides:

setSubscriberState in class CAP1InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setTimeAndTimezone

public CAP2InitialDPArg setTimeAndTimezone(TimeAndTimezone value)
                                    throws IllegalStateException

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