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

Class CAP4InitialDPArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CCInitialDPArg

CAP1InitialDPArg

CAP2InitialDPArg

CAP3InitialDPArg

CAP4InitialDPArg

All Implemented Interfaces:

DataObject, Serializable

public class CAP4InitialDPArg
extends CAP3InitialDPArg

API for CAP-gsmSSF-gsmSCF-ops-args.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,
         cGEncountered                   CGEncountered OPTIONAL,
         iPSSPCapabilities               IPSSPCapabilities OPTIONAL,
         locationNumber                  LocationNumber OPTIONAL,
         originalCalledPartyID           OriginalCalledPartyID OPTIONAL,
         extensions                      Extensions OPTIONAL,
         highLayerCompatibility          HighLayerCompatibility OPTIONAL,
         additionalCallingPartyNumber    AdditionalCallingPartyNumber OPTIONAL,
         bearerCapability                BearerCapability OPTIONAL,
         eventTypeBCSM                   EventTypeBCSM OPTIONAL,
         redirectingPartyID              RedirectingPartyID OPTIONAL,
         redirectionInformation          RedirectionInformation OPTIONAL,
         cause                           Cause OPTIONAL,
         serviceInteractionIndicatorsTwo ServiceInteractionIndicatorsTwo OPTIONAL,
         carrier                         Carrier OPTIONAL,
         cug-Index                       CUG-Index OPTIONAL,
         cug-Interlock                   CUG-Interlock OPTIONAL,
         cug-OutgoingAccess              NULL 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,
         callForwardingSS-Pending        NULL OPTIONAL,
         initialDPArgExtension           InitialDPArgExtension OPTIONAL,
         ...
     }
 CAP-gsmSSF-gsmSCF-ops-args {
     InitialDPArg {
         @parentType com.opencloud.slee.resources.cgin.cap_v3.CAP3InitialDPArg
     }
 }
 

Used as argument type by CAP4Operations.initialDP.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
CAP4InitialDPArg	clone()	Constructs a copy of this object and everything reachable from it.
static CAP4InitialDPArg	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.
boolean	hasCallForwardingSS_Pending()	Tests whether the field callForwardingSS-Pending is present.
CAP4InitialDPArg	setAdditionalCallingPartyNumber(GenericNumber value)	Sets the value of the field additionalCallingPartyNumber.
CAP4InitialDPArg	setBearerCapability(CCBearerCapability value)	Sets the value of the field bearerCapability.
CAP4InitialDPArg	setCalledPartyBCDNumber(CalledPartyBCDNumber value)	Sets the value of the field calledPartyBCDNumber.
CAP4InitialDPArg	setCalledPartyNumber(CalledPartyNumber value)	Sets the value of the field calledPartyNumber.
CAP4InitialDPArg	setCallForwardingSS_PendingPresent(boolean flag)	Sets the presence or absence of the optional field callForwardingSS-Pending.
CAP4InitialDPArg	setCallingPartyNumber(CallingPartyNumber value)	Sets the value of the field callingPartyNumber.
CAP4InitialDPArg	setCallingPartysCategory(CallingPartysCategory value)	Sets the value of the field callingPartysCategory.
CAP4InitialDPArg	setCallReferenceNumber(byte[] value)	Sets the value of the field callReferenceNumber.
CAP4InitialDPArg	setCarrier(byte[] value)	Sets the value of the field carrier.
CAP4InitialDPArg	setCause(Cause value)	Sets the value of the field cause.
CAP4InitialDPArg	setCGEncountered(CAP3CGEncountered value)	Sets the value of the field cGEncountered.
CAP4InitialDPArg	setCug_Index(int value)	Sets the value of the field cug-Index.
CAP4InitialDPArg	setCug_IndexPresent(boolean flag)	Sets the presence or absence of the optional field cug-Index.
CAP4InitialDPArg	setCug_Interlock(CUGInterLockCode value)	Sets the value of the field cug-Interlock.
CAP4InitialDPArg	setCug_OutgoingAccessPresent(boolean flag)	Sets the presence or absence of the optional field cug-OutgoingAccess.
CAP4InitialDPArg	setEventTypeBCSM(CCEventTypeBCSM value)	Sets the value of the field eventTypeBCSM.
CAP4InitialDPArg	setExt_basicServiceCode(MAPExt_BasicServiceCode value)	Sets the value of the field ext-basicServiceCode.
CAP4InitialDPArg	setExtensions(CAP1ExtensionField[] value)	Sets the value of the field extensions.
CAP4InitialDPArg	setHighLayerCompatibility(HighLayerCompatibility value)	Sets the value of the field highLayerCompatibility.
CAP4InitialDPArg	setIMSI(IMSIAddress value)	Sets the value of the field iMSI.
CAP4InitialDPArg	setInitialDPArgExtension(CAP4InitialDPArgExtension value)	Sets the value of the field initialDPArgExtension.
CAP4InitialDPArg	setIPSSPCapabilities(CAP2IPSSPCapabilities value)	Sets the value of the field iPSSPCapabilities.
CAP4InitialDPArg	setLocationInformation(MAPLocationInformation value)	Sets the value of the field locationInformation.
CAP4InitialDPArg	setLocationNumber(LocationNumber value)	Sets the value of the field locationNumber.
CAP4InitialDPArg	setMscAddress(AddressString value)	Sets the value of the field mscAddress.
CAP4InitialDPArg	setOriginalCalledPartyID(OriginalCalledNumber value)	Sets the value of the field originalCalledPartyID.
CAP4InitialDPArg	setRedirectingPartyID(RedirectingPartyNumber value)	Sets the value of the field redirectingPartyID.
CAP4InitialDPArg	setRedirectionInformation(RedirectionInformation value)	Sets the value of the field redirectionInformation.
CAP4InitialDPArg	setServiceInteractionIndicatorsTwo(CAP3ServiceInteractionIndicatorsTwo value)	Sets the value of the field serviceInteractionIndicatorsTwo.
CAP4InitialDPArg	setServiceKey(int value)	Sets the value of the field serviceKey.
CAP4InitialDPArg	setSubscriberState(MAPSubscriberState value)	Sets the value of the field subscriberState.
CAP4InitialDPArg	setTimeAndTimezone(TimeAndTimezone value)	Sets the value of the field timeAndTimezone.

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

getCarrier, getCause, getCGEncountered, getCug_Index, getCug_Interlock, getServiceInteractionIndicatorsTwo, hasCarrier, hasCause, hasCGEncountered, hasCug_Index, hasCug_Interlock, hasCug_OutgoingAccess, hasServiceInteractionIndicatorsTwo, setGsm_ForwardingPendingPresent, setInitialDPArgExtension, setReadOnly

Methods inherited from class com.opencloud.slee.resources.cgin.cap_v2.CAP2InitialDPArg

getInitialDPArgExtension, getTimeAndTimezone, hasGsm_ForwardingPending, hasInitialDPArgExtension, hasTimeAndTimezone

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

CAP4InitialDPArg

public CAP4InitialDPArg()

Constructs an object with uninitialised state.

Method Detail

clone

public CAP4InitialDPArg clone()

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

Specified by:

clone in interface DataObject

Overrides:

clone in class CAP3InitialDPArg

Returns:

copy of object

copyOf

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

CAP4InitialDPArg

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 CAP3InitialDPArg

Parameters:

withAbsents - whether to put absent optional fields into Map

Returns:

Map from field-name to field-value

hasCallForwardingSS_Pending

public boolean hasCallForwardingSS_Pending()

Tests whether the field callForwardingSS-Pending is present.

Returns:

whether the field callForwardingSS-Pending is present

setAdditionalCallingPartyNumber

public CAP4InitialDPArg setAdditionalCallingPartyNumber(GenericNumber value)
                                                 throws IllegalStateException

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

Overrides:

setAdditionalCallingPartyNumber in class CAP3InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setBearerCapability

public CAP4InitialDPArg setBearerCapability(CCBearerCapability value)
                                     throws IllegalStateException

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

Overrides:

setBearerCapability in class CAP3InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCGEncountered

public CAP4InitialDPArg setCGEncountered(CAP3CGEncountered value)
                                  throws IllegalStateException

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

Overrides:

setCGEncountered in class CAP3InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCallForwardingSS_PendingPresent

public CAP4InitialDPArg setCallForwardingSS_PendingPresent(boolean flag)
                                                    throws IllegalStateException

Sets the presence or absence of the optional field callForwardingSS-Pending.

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

setCallReferenceNumber

public CAP4InitialDPArg setCallReferenceNumber(byte[] value)
                                        throws IllegalStateException

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

Overrides:

setCallReferenceNumber in class CAP3InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCalledPartyBCDNumber

public CAP4InitialDPArg setCalledPartyBCDNumber(CalledPartyBCDNumber value)
                                         throws IllegalStateException

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

Overrides:

setCalledPartyBCDNumber in class CAP3InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCalledPartyNumber

public CAP4InitialDPArg setCalledPartyNumber(CalledPartyNumber value)
                                      throws IllegalStateException

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

Overrides:

setCalledPartyNumber in class CAP3InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCallingPartyNumber

public CAP4InitialDPArg setCallingPartyNumber(CallingPartyNumber value)
                                       throws IllegalStateException

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

Overrides:

setCallingPartyNumber in class CAP3InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCallingPartysCategory

public CAP4InitialDPArg setCallingPartysCategory(CallingPartysCategory value)
                                          throws IllegalStateException

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

Overrides:

setCallingPartysCategory in class CAP3InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCarrier

public CAP4InitialDPArg setCarrier(byte[] value)
                            throws IllegalStateException

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

Overrides:

setCarrier in class CAP3InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCause

public CAP4InitialDPArg setCause(Cause value)
                          throws IllegalStateException

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

Overrides:

setCause in class CAP3InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCug_Index

public CAP4InitialDPArg setCug_Index(int value)
                              throws IllegalStateException

Sets the value of the field cug-Index. If null, marks the field as absent.

Overrides:

setCug_Index in class CAP3InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCug_IndexPresent

public CAP4InitialDPArg setCug_IndexPresent(boolean flag)
                                     throws IllegalStateException

Sets the presence or absence of the optional field cug-Index.

Overrides:

setCug_IndexPresent in class CAP3InitialDPArg

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

setCug_Interlock

public CAP4InitialDPArg setCug_Interlock(CUGInterLockCode value)
                                  throws IllegalStateException

Sets the value of the field cug-Interlock. If null, marks the field as absent.

Overrides:

setCug_Interlock in class CAP3InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCug_OutgoingAccessPresent

public CAP4InitialDPArg setCug_OutgoingAccessPresent(boolean flag)
                                              throws IllegalStateException

Sets the presence or absence of the optional field cug-OutgoingAccess.

Overrides:

setCug_OutgoingAccessPresent in class CAP3InitialDPArg

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

setEventTypeBCSM

public CAP4InitialDPArg setEventTypeBCSM(CCEventTypeBCSM value)
                                  throws IllegalStateException

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

Overrides:

setEventTypeBCSM in class CAP3InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setExt_basicServiceCode

public CAP4InitialDPArg 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 CAP3InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setExtensions

public CAP4InitialDPArg setExtensions(CAP1ExtensionField[] value)
                               throws IllegalStateException

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

Overrides:

setExtensions in class CAP3InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setHighLayerCompatibility

public CAP4InitialDPArg setHighLayerCompatibility(HighLayerCompatibility value)
                                           throws IllegalStateException

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

Overrides:

setHighLayerCompatibility in class CAP3InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setIMSI

public CAP4InitialDPArg setIMSI(IMSIAddress value)
                         throws IllegalStateException

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

Overrides:

setIMSI in class CAP3InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setIPSSPCapabilities

public CAP4InitialDPArg setIPSSPCapabilities(CAP2IPSSPCapabilities value)
                                      throws IllegalStateException

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

Overrides:

setIPSSPCapabilities in class CAP3InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setInitialDPArgExtension

public CAP4InitialDPArg setInitialDPArgExtension(CAP4InitialDPArgExtension 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 CAP4InitialDPArg setLocationInformation(MAPLocationInformation value)
                                        throws IllegalStateException

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

Overrides:

setLocationInformation in class CAP3InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setLocationNumber

public CAP4InitialDPArg setLocationNumber(LocationNumber value)
                                   throws IllegalStateException

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

Overrides:

setLocationNumber in class CAP3InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setMscAddress

public CAP4InitialDPArg setMscAddress(AddressString value)
                               throws IllegalStateException

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

Overrides:

setMscAddress in class CAP3InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setOriginalCalledPartyID

public CAP4InitialDPArg setOriginalCalledPartyID(OriginalCalledNumber value)
                                          throws IllegalStateException

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

Overrides:

setOriginalCalledPartyID in class CAP3InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setRedirectingPartyID

public CAP4InitialDPArg setRedirectingPartyID(RedirectingPartyNumber value)
                                       throws IllegalStateException

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

Overrides:

setRedirectingPartyID in class CAP3InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setRedirectionInformation

public CAP4InitialDPArg setRedirectionInformation(RedirectionInformation value)
                                           throws IllegalStateException

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

Overrides:

setRedirectionInformation in class CAP3InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setServiceInteractionIndicatorsTwo

public CAP4InitialDPArg setServiceInteractionIndicatorsTwo(CAP3ServiceInteractionIndicatorsTwo value)
                                                    throws IllegalStateException

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

Overrides:

setServiceInteractionIndicatorsTwo in class CAP3InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setServiceKey

public CAP4InitialDPArg setServiceKey(int value)
                               throws IllegalStateException

Sets the value of the field serviceKey.

Overrides:

setServiceKey in class CAP3InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setSubscriberState

public CAP4InitialDPArg setSubscriberState(MAPSubscriberState value)
                                    throws IllegalStateException

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

Overrides:

setSubscriberState in class CAP3InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setTimeAndTimezone

public CAP4InitialDPArg setTimeAndTimezone(TimeAndTimezone value)
                                    throws IllegalStateException

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

Overrides:

setTimeAndTimezone in class CAP3InitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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