com.opencloud.slee.resources.cgin.cap_v1

Class CAP1InitialDPArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CCInitialDPArg

CAP1InitialDPArg

All Implemented Interfaces:

DataObject, Serializable

Direct Known Subclasses:

CAP2InitialDPArg

public class CAP1InitialDPArg
extends CCInitialDPArg

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,
         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,
         ...
     }
 CAP-DataTypes {
     InitialDPArg {
         @parentType com.opencloud.slee.resources.cgin.callcontrol.CCInitialDPArg
     }
 }
 

Used as argument type by CAP1Operations.initialDP.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CAP1InitialDPArg	clone() Constructs a copy of this object and everything reachable from it.
static CAP1InitialDPArg	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.
CalledPartyBCDNumber	getCalledPartyBCDNumber() Gets the value of the field calledPartyBCDNumber.
byte[]	getCallReferenceNumber() Gets the value of the field callReferenceNumber.
MAPExt_BasicServiceCode	getExt_basicServiceCode() Gets the value of the field ext-basicServiceCode.
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.
IMSIAddress	getIMSI() Gets the value of the field iMSI.
MAPLocationInformation	getLocationInformation() Gets the value of the field locationInformation.
AddressString	getMscAddress() Gets the value of the field mscAddress.
MAPSubscriberState	getSubscriberState() Gets the value of the field subscriberState.
boolean	hasCalledPartyBCDNumber() Tests whether the field calledPartyBCDNumber has a value.
boolean	hasCallReferenceNumber() Tests whether the field callReferenceNumber has a value.
boolean	hasExt_basicServiceCode() Tests whether the field ext-basicServiceCode has a value.
boolean	hasExtensions() Tests whether the field extensions has a value.
boolean	hasIMSI() Tests whether the field iMSI has a value.
boolean	hasLocationInformation() Tests whether the field locationInformation has a value.
boolean	hasMscAddress() Tests whether the field mscAddress has a value.
boolean	hasSubscriberState() Tests whether the field subscriberState has a value.
CAP1InitialDPArg	setAdditionalCallingPartyNumber(GenericNumber value) Sets the value of the field additionalCallingPartyNumber.
CAP1InitialDPArg	setBearerCapability(CCBearerCapability value) Sets the value of the field bearerCapability.
CAP1InitialDPArg	setCalledPartyBCDNumber(CalledPartyBCDNumber value) Sets the value of the field calledPartyBCDNumber.
CAP1InitialDPArg	setCalledPartyNumber(CalledPartyNumber value) Sets the value of the field calledPartyNumber.
CAP1InitialDPArg	setCallingPartyNumber(CallingPartyNumber value) Sets the value of the field callingPartyNumber.
CAP1InitialDPArg	setCallingPartysCategory(CallingPartysCategory value) Sets the value of the field callingPartysCategory.
CAP1InitialDPArg	setCallReferenceNumber(byte[] value) Sets the value of the field callReferenceNumber.
CAP1InitialDPArg	setEventTypeBCSM(CCEventTypeBCSM value) Sets the value of the field eventTypeBCSM.
CAP1InitialDPArg	setExt_basicServiceCode(MAPExt_BasicServiceCode value) Sets the value of the field ext-basicServiceCode.
CAP1InitialDPArg	setExtensions(CAP1ExtensionField[] value) Sets the value of the field extensions.
CAP1InitialDPArg	setHighLayerCompatibility(HighLayerCompatibility value) Sets the value of the field highLayerCompatibility.
CAP1InitialDPArg	setIMSI(IMSIAddress value) Sets the value of the field iMSI.
CAP1InitialDPArg	setLocationInformation(MAPLocationInformation value) Sets the value of the field locationInformation.
CAP1InitialDPArg	setLocationNumber(LocationNumber value) Sets the value of the field locationNumber.
CAP1InitialDPArg	setMscAddress(AddressString value) Sets the value of the field mscAddress.
CAP1InitialDPArg	setOriginalCalledPartyID(OriginalCalledNumber value) Sets the value of the field originalCalledPartyID.
void	setReadOnly() Sets this and all its fields to be immutable.
CAP1InitialDPArg	setRedirectingPartyID(RedirectingPartyNumber value) Sets the value of the field redirectingPartyID.
CAP1InitialDPArg	setRedirectionInformation(RedirectionInformation value) Sets the value of the field redirectionInformation.
CAP1InitialDPArg	setServiceKey(int value) Sets the value of the field serviceKey.
CAP1InitialDPArg	setSubscriberState(MAPSubscriberState value) Sets the value of the field subscriberState.

Methods inherited from class 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

CAP1InitialDPArg

public CAP1InitialDPArg()

Constructs an object with uninitialised state.

Method Detail

clone

public CAP1InitialDPArg clone()

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

Specified by:

clone in interface DataObject

Overrides:

clone in class CCInitialDPArg

Returns:

copy of object

copyOf

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

CAP1InitialDPArg

getCallReferenceNumber

public byte[] getCallReferenceNumber()

Gets the value of the field callReferenceNumber.

Returns:

value of field callReferenceNumber, or null if not present

getCalledPartyBCDNumber

public CalledPartyBCDNumber getCalledPartyBCDNumber()

Gets the value of the field calledPartyBCDNumber.

Returns:

value of field calledPartyBCDNumber, or null if not present

getExt_basicServiceCode

public MAPExt_BasicServiceCode getExt_basicServiceCode()

Gets the value of the field ext-basicServiceCode.

Returns:

value of field ext-basicServiceCode, 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.

Overrides:

getFieldsMap in class CCInitialDPArg

Parameters:

withAbsents - whether to put absent optional fields into Map

Returns:

Map from field-name to field-value

getIMSI

public IMSIAddress getIMSI()

Gets the value of the field iMSI.

Returns:

value of field iMSI, or null if not present

getLocationInformation

public MAPLocationInformation getLocationInformation()

Gets the value of the field locationInformation.

Returns:

value of field locationInformation, or null if not present

getMscAddress

public AddressString getMscAddress()

Gets the value of the field mscAddress.

Returns:

value of field mscAddress, or null if not present

getSubscriberState

public MAPSubscriberState getSubscriberState()

Gets the value of the field subscriberState.

Returns:

value of field subscriberState, or null if not present

hasCallReferenceNumber

public boolean hasCallReferenceNumber()

Tests whether the field callReferenceNumber has a value.

Returns:

whether the field callReferenceNumber has a value

hasCalledPartyBCDNumber

public boolean hasCalledPartyBCDNumber()

Tests whether the field calledPartyBCDNumber has a value.

Returns:

whether the field calledPartyBCDNumber has a value

hasExt_basicServiceCode

public boolean hasExt_basicServiceCode()

Tests whether the field ext-basicServiceCode has a value.

Returns:

whether the field ext-basicServiceCode has a value

hasExtensions

public boolean hasExtensions()

Tests whether the field extensions has a value.

Returns:

whether the field extensions has a value

hasIMSI

public boolean hasIMSI()

Tests whether the field iMSI has a value.

Returns:

whether the field iMSI has a value

hasLocationInformation

public boolean hasLocationInformation()

Tests whether the field locationInformation has a value.

Returns:

whether the field locationInformation has a value

hasMscAddress

public boolean hasMscAddress()

Tests whether the field mscAddress has a value.

Returns:

whether the field mscAddress has a value

hasSubscriberState

public boolean hasSubscriberState()

Tests whether the field subscriberState has a value.

Returns:

whether the field subscriberState has a value

setAdditionalCallingPartyNumber

public CAP1InitialDPArg setAdditionalCallingPartyNumber(GenericNumber value)
                                                 throws IllegalStateException

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

Overrides:

setAdditionalCallingPartyNumber in class CCInitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setBearerCapability

public CAP1InitialDPArg setBearerCapability(CCBearerCapability value)
                                     throws IllegalStateException

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

Overrides:

setBearerCapability in class CCInitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCallReferenceNumber

public CAP1InitialDPArg setCallReferenceNumber(byte[] value)
                                        throws IllegalStateException

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

setCalledPartyBCDNumber

public CAP1InitialDPArg setCalledPartyBCDNumber(CalledPartyBCDNumber value)
                                         throws IllegalStateException

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

setCalledPartyNumber

public CAP1InitialDPArg setCalledPartyNumber(CalledPartyNumber value)
                                      throws IllegalStateException

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

Overrides:

setCalledPartyNumber in class CCInitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCallingPartyNumber

public CAP1InitialDPArg setCallingPartyNumber(CallingPartyNumber value)
                                       throws IllegalStateException

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

Overrides:

setCallingPartyNumber in class CCInitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCallingPartysCategory

public CAP1InitialDPArg setCallingPartysCategory(CallingPartysCategory value)
                                          throws IllegalStateException

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

Overrides:

setCallingPartysCategory in class CCInitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setEventTypeBCSM

public CAP1InitialDPArg setEventTypeBCSM(CCEventTypeBCSM value)
                                  throws IllegalStateException

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

Overrides:

setEventTypeBCSM in class CCInitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setExt_basicServiceCode

public CAP1InitialDPArg setExt_basicServiceCode(MAPExt_BasicServiceCode value)
                                         throws IllegalStateException

Sets the value of the field ext-basicServiceCode. 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 CAP1InitialDPArg 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

setHighLayerCompatibility

public CAP1InitialDPArg setHighLayerCompatibility(HighLayerCompatibility value)
                                           throws IllegalStateException

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

Overrides:

setHighLayerCompatibility in class CCInitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setIMSI

public CAP1InitialDPArg setIMSI(IMSIAddress value)
                         throws IllegalStateException

Sets the value of the field iMSI. 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 CAP1InitialDPArg setLocationInformation(MAPLocationInformation value)
                                        throws IllegalStateException

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

setLocationNumber

public CAP1InitialDPArg setLocationNumber(LocationNumber value)
                                   throws IllegalStateException

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

Overrides:

setLocationNumber in class CCInitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setMscAddress

public CAP1InitialDPArg setMscAddress(AddressString value)
                               throws IllegalStateException

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

setOriginalCalledPartyID

public CAP1InitialDPArg setOriginalCalledPartyID(OriginalCalledNumber value)
                                          throws IllegalStateException

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

Overrides:

setOriginalCalledPartyID in class CCInitialDPArg

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 CCInitialDPArg

setRedirectingPartyID

public CAP1InitialDPArg setRedirectingPartyID(RedirectingPartyNumber value)
                                       throws IllegalStateException

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

Overrides:

setRedirectingPartyID in class CCInitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setRedirectionInformation

public CAP1InitialDPArg setRedirectionInformation(RedirectionInformation value)
                                           throws IllegalStateException

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

Overrides:

setRedirectionInformation in class CCInitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setServiceKey

public CAP1InitialDPArg setServiceKey(int value)
                               throws IllegalStateException

Sets the value of the field serviceKey.

Overrides:

setServiceKey in class CCInitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setSubscriberState

public CAP1InitialDPArg setSubscriberState(MAPSubscriberState value)
                                    throws IllegalStateException

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