com.opencloud.slee.resources.cgin.cap_v4

Class CAP4EstablishTemporaryConnectionArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CCEstablishTemporaryConnectionArg

CAP2EstablishTemporaryConnectionArg

CAP3EstablishTemporaryConnectionArg

CAP4EstablishTemporaryConnectionArg

All Implemented Interfaces:

DataObject, Serializable

public class CAP4EstablishTemporaryConnectionArg
extends CAP3EstablishTemporaryConnectionArg

API for CAP-gsmSSF-gsmSCF-ops-args.EstablishTemporaryConnectionArg. Generated from the following ASN.1 type definition and the adaptations below.

 EstablishTemporaryConnectionArg ::=
     SEQUENCE {
         assistingSSPIPRoutingAddress    AssistingSSPIPRoutingAddress,
         correlationID                   CorrelationID OPTIONAL,
         scfID                           ScfID OPTIONAL,
         extensions                      Extensions OPTIONAL,
         carrier                         Carrier OPTIONAL,
         serviceInteractionIndicatorsTwo ServiceInteractionIndicatorsTwo OPTIONAL,
         callSegmentID                   CallSegmentID OPTIONAL,
         naOliInfo                       NAOliInfo OPTIONAL,
         chargeNumber                    ChargeNumber OPTIONAL,
         ...
         originalCalledPartyID           OriginalCalledPartyID OPTIONAL,
         callingPartyNumber              CallingPartyNumber OPTIONAL
     }
 CAP-gsmSSF-gsmSCF-ops-args {
     EstablishTemporaryConnectionArg {
         @parentType com.opencloud.slee.resources.cgin.cap_v3.CAP3EstablishTemporaryConnectionArg
         assistingSSPIPRoutingAddress {
             @import com.opencloud.slee.resources.in.datatypes.cc.GenericNumberWithB
             @api {
                 @useAPIType com.opencloud.slee.resources.in.datatypes.cc.GenericNumber
             }
         }
         correlationID {
             @import com.opencloud.slee.resources.in.datatypes.cc.GenericDigits
         }
     }
 }
 

Used as argument type by CAP4Operations.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
CAP4EstablishTemporaryConnectionArg() Constructs an object with uninitialised state.

Method Summary

Methods

Modifier and Type	Method and Description
CAP4EstablishTemporaryConnectionArg	clone() Constructs a copy of this object and everything reachable from it.
static CAP4EstablishTemporaryConnectionArg	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.
CallingPartyNumber	getCallingPartyNumber() Gets the value of the field callingPartyNumber.
int	getCallSegmentID() Gets the value of the field callSegmentID.
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.
OriginalCalledNumber	getOriginalCalledPartyID() Gets the value of the field originalCalledPartyID.
boolean	hasCallingPartyNumber() Tests whether the field callingPartyNumber has a value.
boolean	hasCallSegmentID() Tests whether the field callSegmentID has a value.
boolean	hasOriginalCalledPartyID() Tests whether the field originalCalledPartyID has a value.
CAP4EstablishTemporaryConnectionArg	setAssistingSSPIPRoutingAddress(GenericNumber value) Sets the value of the field assistingSSPIPRoutingAddress.
CAP4EstablishTemporaryConnectionArg	setCallingPartyNumber(CallingPartyNumber value) Sets the value of the field callingPartyNumber.
CAP4EstablishTemporaryConnectionArg	setCallSegmentID(int value) Sets the value of the field callSegmentID and marks the field as present.
CAP4EstablishTemporaryConnectionArg	setCallSegmentIDPresent(boolean flag) Sets the presence or absence of the optional field callSegmentID.
CAP4EstablishTemporaryConnectionArg	setCarrier(byte[] value) Sets the value of the field carrier.
CAP4EstablishTemporaryConnectionArg	setChargeNumber(LocationNumber value) Sets the value of the field chargeNumber.
CAP4EstablishTemporaryConnectionArg	setCorrelationID(GenericDigits value) Sets the value of the field correlationID.
CAP4EstablishTemporaryConnectionArg	setExtensions(CAP1ExtensionField[] value) Sets the value of the field extensions.
CAP4EstablishTemporaryConnectionArg	setNaOliInfo(byte[] value) Sets the value of the field naOliInfo.
CAP4EstablishTemporaryConnectionArg	setOriginalCalledPartyID(OriginalCalledNumber value) Sets the value of the field originalCalledPartyID.
void	setReadOnly() Sets this and all its fields to be immutable.
CAP4EstablishTemporaryConnectionArg	setScfID(CCScfID value) Sets the value of the field scfID.
CAP4EstablishTemporaryConnectionArg	setServiceInteractionIndicatorsTwo(CAP3ServiceInteractionIndicatorsTwo value) Sets the value of the field serviceInteractionIndicatorsTwo.

Methods inherited from class CAP3EstablishTemporaryConnectionArg

getCarrier, getChargeNumber, getNaOliInfo, hasCarrier, hasChargeNumber, hasNaOliInfo

Methods inherited from class CAP2EstablishTemporaryConnectionArg

getExtensions, getNa_info, getServiceInteractionIndicatorsTwo, hasExtensions, hasNa_info, hasServiceInteractionIndicatorsTwo, setNa_info, setServiceInteractionIndicatorsTwo

Methods inherited from class CCEstablishTemporaryConnectionArg

getAssistingSSPIPRoutingAddress, getCginAssistingDialogCorrelationID, getCorrelationID, getScfID, hasAssistingSSPIPRoutingAddress, hasCginAssistingDialogCorrelationID, hasCorrelationID, hasScfID, setCginAssistingDialogCorrelationID

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

CAP4EstablishTemporaryConnectionArg

public CAP4EstablishTemporaryConnectionArg()

Constructs an object with uninitialised state.

Method Detail

clone

public CAP4EstablishTemporaryConnectionArg clone()

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

Specified by:

clone in interface DataObject

Overrides:

clone in class CAP3EstablishTemporaryConnectionArg

Returns:

copy of object

copyOf

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

CAP4EstablishTemporaryConnectionArg

getCallSegmentID

public int getCallSegmentID()

Gets the value of the field callSegmentID.

Returns:

value of field callSegmentID

getCallingPartyNumber

public CallingPartyNumber getCallingPartyNumber()

Gets the value of the field callingPartyNumber.

Returns:

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

Parameters:

withAbsents - whether to put absent optional fields into Map

Returns:

Map from field-name to field-value

getOriginalCalledPartyID

public OriginalCalledNumber getOriginalCalledPartyID()

Gets the value of the field originalCalledPartyID.

Returns:

value of field originalCalledPartyID, or null if not present

hasCallSegmentID

public boolean hasCallSegmentID()

Tests whether the field callSegmentID has a value.

Returns:

whether the field callSegmentID has a value

hasCallingPartyNumber

public boolean hasCallingPartyNumber()

Tests whether the field callingPartyNumber has a value.

Returns:

whether the field callingPartyNumber has a value

hasOriginalCalledPartyID

public boolean hasOriginalCalledPartyID()

Tests whether the field originalCalledPartyID has a value.

Returns:

whether the field originalCalledPartyID has a value

setAssistingSSPIPRoutingAddress

public CAP4EstablishTemporaryConnectionArg setAssistingSSPIPRoutingAddress(GenericNumber value)
                                                                    throws IllegalStateException

Sets the value of the field assistingSSPIPRoutingAddress.

Overrides:

setAssistingSSPIPRoutingAddress in class CAP3EstablishTemporaryConnectionArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCallSegmentID

public CAP4EstablishTemporaryConnectionArg setCallSegmentID(int value)
                                                     throws IllegalStateException

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

setCallSegmentIDPresent

public CAP4EstablishTemporaryConnectionArg setCallSegmentIDPresent(boolean flag)
                                                            throws IllegalStateException

Sets the presence or absence of the optional field callSegmentID.

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

setCallingPartyNumber

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

setCarrier

public CAP4EstablishTemporaryConnectionArg setCarrier(byte[] value)
                                               throws IllegalStateException

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

Overrides:

setCarrier in class CAP3EstablishTemporaryConnectionArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setChargeNumber

public CAP4EstablishTemporaryConnectionArg setChargeNumber(LocationNumber value)
                                                    throws IllegalStateException

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

Overrides:

setChargeNumber in class CAP3EstablishTemporaryConnectionArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCorrelationID

public CAP4EstablishTemporaryConnectionArg setCorrelationID(GenericDigits value)
                                                     throws IllegalStateException

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

Overrides:

setCorrelationID in class CAP3EstablishTemporaryConnectionArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setExtensions

public CAP4EstablishTemporaryConnectionArg setExtensions(CAP1ExtensionField[] value)
                                                  throws IllegalStateException

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

Overrides:

setExtensions in class CAP3EstablishTemporaryConnectionArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setNaOliInfo

public CAP4EstablishTemporaryConnectionArg setNaOliInfo(byte[] value)
                                                 throws IllegalStateException

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

Overrides:

setNaOliInfo in class CAP3EstablishTemporaryConnectionArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setOriginalCalledPartyID

public CAP4EstablishTemporaryConnectionArg setOriginalCalledPartyID(OriginalCalledNumber value)
                                                             throws IllegalStateException

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

setScfID

public CAP4EstablishTemporaryConnectionArg setScfID(CCScfID value)
                                             throws IllegalStateException

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

Overrides:

setScfID in class CAP3EstablishTemporaryConnectionArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setServiceInteractionIndicatorsTwo

public CAP4EstablishTemporaryConnectionArg setServiceInteractionIndicatorsTwo(CAP3ServiceInteractionIndicatorsTwo value)
                                                                       throws IllegalStateException

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

Overrides:

setServiceInteractionIndicatorsTwo in class CAP3EstablishTemporaryConnectionArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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