com.opencloud.slee.resources.cgin.callcontrol

Class CCEstablishTemporaryConnectionArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CCEstablishTemporaryConnectionArg

All Implemented Interfaces:

DataObject, Serializable

Direct Known Subclasses:

CAP2EstablishTemporaryConnectionArg, CS1EstablishTemporaryConnectionArg

public class CCEstablishTemporaryConnectionArg
extends AbstractFieldsObject

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

 EstablishTemporaryConnectionArg ::=
     SEQUENCE {
         assistingSSPIPRoutingAddress     AssistingSSPIPRoutingAddress,
         correlationID                    CorrelationID OPTIONAL,
         scfID                            ScfID OPTIONAL,
         cginAssistingDialogCorrelationID CorrelationID OPTIONAL        -- Used by CGIN assisting dialog correlation only; never sent to the network.
     }
 CC-DataTypes {
     EstablishTemporaryConnectionArg {
         cginAssistingDialogCorrelationID {
             @import com.opencloud.slee.resources.in.datatypes.cc.GenericDigits
         }
         correlationID {
             @import com.opencloud.slee.resources.in.datatypes.cc.GenericDigits
         }
     }
 }
 

Issuing an ETC causes an assisting dialog to be established back to the SCP. When such an inbound assisting dialog is received, CGIN inspects the AssistRequestInstructionsArg.correlationID value to find the dialog that issued the corresponding ETC, and ensures that the new dialog is processed on the same node. Usually, the ARI correlationID is matched against EstablishTemporaryConnectionArg.correlationID. However, to support cases where the ETC correlationID does not exactly match the ARI correlationID, services may optionally specify a value for EstablishTemporaryConnectionArg.cginAssistingDialogCorrelationID; if provided, this value is used when matching assisting dialogs. This special field is only used internally by CGIN and is never sent to the network.

Used as argument type by CCOperations.establishTemporaryConnection.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CCEstablishTemporaryConnectionArg	clone() Constructs a copy of this object and everything reachable from it.
static CCEstablishTemporaryConnectionArg	copyOf(CCEstablishTemporaryConnectionArg 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.
GenericNumber	getAssistingSSPIPRoutingAddress() Gets the value of the field assistingSSPIPRoutingAddress.
GenericDigits	getCginAssistingDialogCorrelationID() Gets the value of the field cginAssistingDialogCorrelationID.
GenericDigits	getCorrelationID() Gets the value of the field correlationID.
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.
CCScfID	getScfID() Gets the value of the field scfID.
boolean	hasAssistingSSPIPRoutingAddress() Tests whether the field assistingSSPIPRoutingAddress has a value.
boolean	hasCginAssistingDialogCorrelationID() Tests whether the field cginAssistingDialogCorrelationID has a value.
boolean	hasCorrelationID() Tests whether the field correlationID has a value.
boolean	hasScfID() Tests whether the field scfID has a value.
CCEstablishTemporaryConnectionArg	setAssistingSSPIPRoutingAddress(GenericNumber value) Sets the value of the field assistingSSPIPRoutingAddress.
CCEstablishTemporaryConnectionArg	setCginAssistingDialogCorrelationID(GenericDigits value) Sets the value of the field cginAssistingDialogCorrelationID.
CCEstablishTemporaryConnectionArg	setCorrelationID(GenericDigits value) Sets the value of the field correlationID.
void	setReadOnly() Sets this and all its fields to be immutable.
CCEstablishTemporaryConnectionArg	setScfID(CCScfID value) Sets the value of the field scfID.

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

CCEstablishTemporaryConnectionArg

public CCEstablishTemporaryConnectionArg()

Constructs an object with uninitialised state.

Method Detail

clone

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

CCEstablishTemporaryConnectionArg

getAssistingSSPIPRoutingAddress

public GenericNumber getAssistingSSPIPRoutingAddress()

Gets the value of the field assistingSSPIPRoutingAddress.

Returns:

value of field assistingSSPIPRoutingAddress, or null if not present

getCginAssistingDialogCorrelationID

public GenericDigits getCginAssistingDialogCorrelationID()

Gets the value of the field cginAssistingDialogCorrelationID.

Returns:

value of field cginAssistingDialogCorrelationID, or null if not present

getCorrelationID

public GenericDigits getCorrelationID()

Gets the value of the field correlationID.

Returns:

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

getScfID

public CCScfID getScfID()

Gets the value of the field scfID.

Returns:

value of field scfID, or null if not present

hasAssistingSSPIPRoutingAddress

public boolean hasAssistingSSPIPRoutingAddress()

Tests whether the field assistingSSPIPRoutingAddress has a value.

Returns:

whether the field assistingSSPIPRoutingAddress has a value

hasCginAssistingDialogCorrelationID

public boolean hasCginAssistingDialogCorrelationID()

Tests whether the field cginAssistingDialogCorrelationID has a value.

Returns:

whether the field cginAssistingDialogCorrelationID has a value

hasCorrelationID

public boolean hasCorrelationID()

Tests whether the field correlationID has a value.

Returns:

whether the field correlationID has a value

hasScfID

public boolean hasScfID()

Tests whether the field scfID has a value.

Returns:

whether the field scfID has a value

setAssistingSSPIPRoutingAddress

public CCEstablishTemporaryConnectionArg setAssistingSSPIPRoutingAddress(GenericNumber value)
                                                                  throws IllegalStateException

Sets the value of the field assistingSSPIPRoutingAddress.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCginAssistingDialogCorrelationID

public CCEstablishTemporaryConnectionArg setCginAssistingDialogCorrelationID(GenericDigits value)
                                                                      throws IllegalStateException

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

setCorrelationID

public CCEstablishTemporaryConnectionArg setCorrelationID(GenericDigits value)
                                                   throws IllegalStateException

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

setScfID

public CCEstablishTemporaryConnectionArg setScfID(CCScfID value)
                                           throws IllegalStateException

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