com.opencloud.slee.resources.cgin.cap_v4

Class CAP4InitiateCallAttemptArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CAP4InitiateCallAttemptArg

All Implemented Interfaces:

DataObject, Serializable

public class CAP4InitiateCallAttemptArg
extends AbstractFieldsObject

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

 InitiateCallAttemptArg ::=
     SEQUENCE {
         destinationRoutingAddress DestinationRoutingAddress,
         extensions                Extensions OPTIONAL,
         legToBeCreated            LegID OPTIONAL,
         newCallSegment            CallSegmentID OPTIONAL,
         callingPartyNumber        CallingPartyNumber OPTIONAL,
         callReferenceNumber       CallReferenceNumber OPTIONAL,
         gsmSCFAddress             ISDN-AddressString OPTIONAL,
         suppress-T-CSI            NULL OPTIONAL,
         ...
     }
 

Used as argument type by CAP4Operations.initiateCallAttempt.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CAP4InitiateCallAttemptArg	clone() Constructs a copy of this object and everything reachable from it.
static CAP4InitiateCallAttemptArg	copyOf(CAP4InitiateCallAttemptArg 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.
CallingPartyNumber	getCallingPartyNumber() Gets the value of the field callingPartyNumber.
byte[]	getCallReferenceNumber() Gets the value of the field callReferenceNumber.
CalledPartyNumber[]	getDestinationRoutingAddress() Gets the value of the field destinationRoutingAddress.
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.
AddressString	getGsmSCFAddress() Gets the value of the field gsmSCFAddress.
CCLegID	getLegToBeCreated() Gets the value of the field legToBeCreated.
int	getNewCallSegment() Gets the value of the field newCallSegment.
boolean	hasCallingPartyNumber() Tests whether the field callingPartyNumber has a value.
boolean	hasCallReferenceNumber() Tests whether the field callReferenceNumber has a value.
boolean	hasDestinationRoutingAddress() Tests whether the field destinationRoutingAddress has a value.
boolean	hasExtensions() Tests whether the field extensions has a value.
boolean	hasGsmSCFAddress() Tests whether the field gsmSCFAddress has a value.
boolean	hasLegToBeCreated() Tests whether the field legToBeCreated has a value.
boolean	hasNewCallSegment() Tests whether the field newCallSegment has a value.
boolean	hasSuppress_T_CSI() Tests whether the field suppress-T-CSI is present.
CAP4InitiateCallAttemptArg	setCallingPartyNumber(CallingPartyNumber value) Sets the value of the field callingPartyNumber.
CAP4InitiateCallAttemptArg	setCallReferenceNumber(byte[] value) Sets the value of the field callReferenceNumber.
CAP4InitiateCallAttemptArg	setDestinationRoutingAddress(CalledPartyNumber[] value) Sets the value of the field destinationRoutingAddress.
CAP4InitiateCallAttemptArg	setExtensions(CAP1ExtensionField[] value) Sets the value of the field extensions.
CAP4InitiateCallAttemptArg	setGsmSCFAddress(AddressString value) Sets the value of the field gsmSCFAddress.
CAP4InitiateCallAttemptArg	setLegToBeCreated(CCLegID value) Sets the value of the field legToBeCreated.
CAP4InitiateCallAttemptArg	setNewCallSegment(int value) Sets the value of the field newCallSegment and marks the field as present.
CAP4InitiateCallAttemptArg	setNewCallSegmentPresent(boolean flag) Sets the presence or absence of the optional field newCallSegment.
void	setReadOnly() Sets this and all its fields to be immutable.
CAP4InitiateCallAttemptArg	setSuppress_T_CSIPresent(boolean flag) Sets the presence or absence of the optional field suppress-T-CSI.

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

CAP4InitiateCallAttemptArg

public CAP4InitiateCallAttemptArg()

Constructs an object with uninitialised state.

Method Detail

clone

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

CAP4InitiateCallAttemptArg

getCallReferenceNumber

public byte[] getCallReferenceNumber()

Gets the value of the field callReferenceNumber.

Returns:

value of field callReferenceNumber, or null if not present

getCallingPartyNumber

public CallingPartyNumber getCallingPartyNumber()

Gets the value of the field callingPartyNumber.

Returns:

value of field callingPartyNumber, or null if not present

getDestinationRoutingAddress

public CalledPartyNumber[] getDestinationRoutingAddress()

Gets the value of the field destinationRoutingAddress.

Returns:

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

getGsmSCFAddress

public AddressString getGsmSCFAddress()

Gets the value of the field gsmSCFAddress.

Returns:

value of field gsmSCFAddress, or null if not present

getLegToBeCreated

public CCLegID getLegToBeCreated()

Gets the value of the field legToBeCreated.

Returns:

value of field legToBeCreated, or null if not present

getNewCallSegment

public int getNewCallSegment()

Gets the value of the field newCallSegment.

Returns:

value of field newCallSegment

hasCallReferenceNumber

public boolean hasCallReferenceNumber()

Tests whether the field callReferenceNumber has a value.

Returns:

whether the field callReferenceNumber has a value

hasCallingPartyNumber

public boolean hasCallingPartyNumber()

Tests whether the field callingPartyNumber has a value.

Returns:

whether the field callingPartyNumber has a value

hasDestinationRoutingAddress

public boolean hasDestinationRoutingAddress()

Tests whether the field destinationRoutingAddress has a value.

Returns:

whether the field destinationRoutingAddress has a value

hasExtensions

public boolean hasExtensions()

Tests whether the field extensions has a value.

Returns:

whether the field extensions has a value

hasGsmSCFAddress

public boolean hasGsmSCFAddress()

Tests whether the field gsmSCFAddress has a value.

Returns:

whether the field gsmSCFAddress has a value

hasLegToBeCreated

public boolean hasLegToBeCreated()

Tests whether the field legToBeCreated has a value.

Returns:

whether the field legToBeCreated has a value

hasNewCallSegment

public boolean hasNewCallSegment()

Tests whether the field newCallSegment has a value.

Returns:

whether the field newCallSegment has a value

hasSuppress_T_CSI

public boolean hasSuppress_T_CSI()

Tests whether the field suppress-T-CSI is present.

Returns:

whether the field suppress-T-CSI is present

setCallReferenceNumber

public CAP4InitiateCallAttemptArg 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

setCallingPartyNumber

public CAP4InitiateCallAttemptArg setCallingPartyNumber(CallingPartyNumber value)
                                                 throws IllegalStateException

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

setDestinationRoutingAddress

public CAP4InitiateCallAttemptArg setDestinationRoutingAddress(CalledPartyNumber[] value)
                                                        throws IllegalStateException

Sets the value of the field destinationRoutingAddress.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setExtensions

public CAP4InitiateCallAttemptArg 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

setGsmSCFAddress

public CAP4InitiateCallAttemptArg setGsmSCFAddress(AddressString value)
                                            throws IllegalStateException

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

setLegToBeCreated

public CAP4InitiateCallAttemptArg setLegToBeCreated(CCLegID value)
                                             throws IllegalStateException

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

setNewCallSegment

public CAP4InitiateCallAttemptArg setNewCallSegment(int value)
                                             throws IllegalStateException

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

setNewCallSegmentPresent

public CAP4InitiateCallAttemptArg setNewCallSegmentPresent(boolean flag)
                                                    throws IllegalStateException

Sets the presence or absence of the optional field newCallSegment.

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

setReadOnly

public void setReadOnly()

Sets this and all its fields to be immutable.

Specified by:

setReadOnly in interface DataObject

Overrides:

setReadOnly in class AbstractDataObject

setSuppress_T_CSIPresent

public CAP4InitiateCallAttemptArg setSuppress_T_CSIPresent(boolean flag)
                                                    throws IllegalStateException

Sets the presence or absence of the optional field suppress-T-CSI.

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