com.opencloud.slee.resources.cgin.etsi_inap_cs1

Class CS1ConnectArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CCConnectArg

CS1ConnectArg

All Implemented Interfaces:

DataObject, Serializable

public class CS1ConnectArg
extends CCConnectArg

API for Core-INAP-CS1-DataTypes.ConnectArg. Generated from the following ASN.1 type definition and the adaptations below.

 ConnectArg ::=
     SEQUENCE {
         destinationRoutingAddress    DestinationRoutingAddress,
         alertingPattern              AlertingPattern OPTIONAL,
         correlationID                CorrelationID OPTIONAL,
         cutAndPaste                  CutAndPaste OPTIONAL,
         originalCalledPartyID        OriginalCalledPartyID OPTIONAL,
         routeList                    RouteList OPTIONAL,
         scfID                        ScfID OPTIONAL,
         extensions                   SEQUENCE (SIZE (1..1000)) OF ExtensionField OPTIONAL,
         serviceInteractionIndicators ServiceInteractionIndicators OPTIONAL,
         callingPartyNumber           CallingPartyNumber OPTIONAL,
         callingPartysCategory        CallingPartysCategory OPTIONAL,
         redirectingPartyID           RedirectingPartyID OPTIONAL,
         redirectionInformation       RedirectionInformation OPTIONAL,
         ...
     }
 Core-INAP-CS1-DataTypes {
     ConnectArg {
         @parentType com.opencloud.slee.resources.cgin.callcontrol.CCConnectArg
         correlationID {
             @import com.opencloud.slee.resources.in.datatypes.cc.GenericDigits
         }
     }
 }
 

Used as argument type by CS1Operations.connect.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CS1ConnectArg	clone() Constructs a copy of this object and everything reachable from it.
static CS1ConnectArg	copyOf(CCConnectArg 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.
GenericDigits	getCorrelationID() Gets the value of the field correlationID.
int	getCutAndPaste() Gets the value of the field cutAndPaste.
CS1ExtensionField[]	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.
byte[][]	getRouteList() Gets the value of the field routeList.
CCScfID	getScfID() Gets the value of the field scfID.
CS1ServiceInteractionIndicators	getServiceInteractionIndicators() Gets the value of the field serviceInteractionIndicators.
boolean	hasCallingPartyNumber() Tests whether the field callingPartyNumber has a value.
boolean	hasCorrelationID() Tests whether the field correlationID has a value.
boolean	hasCutAndPaste() Tests whether the field cutAndPaste has a value.
boolean	hasExtensions() Tests whether the field extensions has a value.
boolean	hasRouteList() Tests whether the field routeList has a value.
boolean	hasScfID() Tests whether the field scfID has a value.
boolean	hasServiceInteractionIndicators() Tests whether the field serviceInteractionIndicators has a value.
CS1ConnectArg	setAlertingPattern(Signal value) Sets the value of the field alertingPattern.
CS1ConnectArg	setCallingPartyNumber(CallingPartyNumber value) Sets the value of the field callingPartyNumber.
CS1ConnectArg	setCallingPartysCategory(CallingPartysCategory value) Sets the value of the field callingPartysCategory.
CS1ConnectArg	setCorrelationID(GenericDigits value) Sets the value of the field correlationID.
CS1ConnectArg	setCutAndPaste(int value) Sets the value of the field cutAndPaste and marks the field as present.
CS1ConnectArg	setCutAndPastePresent(boolean flag) Sets the presence or absence of the optional field cutAndPaste.
CS1ConnectArg	setDestinationRoutingAddress(CalledPartyNumber[] value) Sets the value of the field destinationRoutingAddress.
CS1ConnectArg	setExtensions(CS1ExtensionField[] value) Sets the value of the field extensions.
CS1ConnectArg	setOriginalCalledPartyID(OriginalCalledNumber value) Sets the value of the field originalCalledPartyID.
void	setReadOnly() Sets this and all its fields to be immutable.
CS1ConnectArg	setRedirectingPartyID(RedirectingPartyNumber value) Sets the value of the field redirectingPartyID.
CS1ConnectArg	setRedirectionInformation(RedirectionInformation value) Sets the value of the field redirectionInformation.
CS1ConnectArg	setRouteList(byte[][] value) Sets the value of the field routeList.
CS1ConnectArg	setScfID(CCScfID value) Sets the value of the field scfID.
CS1ConnectArg	setServiceInteractionIndicators(CS1ServiceInteractionIndicators value) Sets the value of the field serviceInteractionIndicators.

Methods inherited from class CCConnectArg

getAlertingPattern, getCallingPartysCategory, getDestinationRoutingAddress, getOriginalCalledPartyID, getRedirectingPartyID, getRedirectionInformation, hasAlertingPattern, hasCallingPartysCategory, hasDestinationRoutingAddress, hasOriginalCalledPartyID, hasRedirectingPartyID, hasRedirectionInformation

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

CS1ConnectArg

public CS1ConnectArg()

Constructs an object with uninitialised state.

Method Detail

clone

public CS1ConnectArg clone()

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

Specified by:

clone in interface DataObject

Overrides:

clone in class CCConnectArg

Returns:

copy of object

copyOf

public static CS1ConnectArg copyOf(CCConnectArg 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:

CS1ConnectArg

getCallingPartyNumber

public CallingPartyNumber getCallingPartyNumber()

Gets the value of the field callingPartyNumber.

Returns:

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

getCutAndPaste

public int getCutAndPaste()

Gets the value of the field cutAndPaste.

Returns:

value of field cutAndPaste

getExtensions

public CS1ExtensionField[] 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 CCConnectArg

Parameters:

withAbsents - whether to put absent optional fields into Map

Returns:

Map from field-name to field-value

getRouteList

public byte[][] getRouteList()

Gets the value of the field routeList.

Returns:

value of field routeList, or null if not present

getScfID

public CCScfID getScfID()

Gets the value of the field scfID.

Returns:

value of field scfID, or null if not present

getServiceInteractionIndicators

public CS1ServiceInteractionIndicators getServiceInteractionIndicators()

Gets the value of the field serviceInteractionIndicators.

Returns:

value of field serviceInteractionIndicators, or null if not present

hasCallingPartyNumber

public boolean hasCallingPartyNumber()

Tests whether the field callingPartyNumber has a value.

Returns:

whether the field callingPartyNumber has a value

hasCorrelationID

public boolean hasCorrelationID()

Tests whether the field correlationID has a value.

Returns:

whether the field correlationID has a value

hasCutAndPaste

public boolean hasCutAndPaste()

Tests whether the field cutAndPaste has a value.

Returns:

whether the field cutAndPaste has a value

hasExtensions

public boolean hasExtensions()

Tests whether the field extensions has a value.

Returns:

whether the field extensions has a value

hasRouteList

public boolean hasRouteList()

Tests whether the field routeList has a value.

Returns:

whether the field routeList has a value

hasScfID

public boolean hasScfID()

Tests whether the field scfID has a value.

Returns:

whether the field scfID has a value

hasServiceInteractionIndicators

public boolean hasServiceInteractionIndicators()

Tests whether the field serviceInteractionIndicators has a value.

Returns:

whether the field serviceInteractionIndicators has a value

setAlertingPattern

public CS1ConnectArg setAlertingPattern(Signal value)
                                 throws IllegalStateException

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

Overrides:

setAlertingPattern in class CCConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCallingPartyNumber

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

setCallingPartysCategory

public CS1ConnectArg setCallingPartysCategory(CallingPartysCategory value)
                                       throws IllegalStateException

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

Overrides:

setCallingPartysCategory in class CCConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCorrelationID

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

setCutAndPaste

public CS1ConnectArg setCutAndPaste(int value)
                             throws IllegalStateException

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

setCutAndPastePresent

public CS1ConnectArg setCutAndPastePresent(boolean flag)
                                    throws IllegalStateException

Sets the presence or absence of the optional field cutAndPaste.

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

setDestinationRoutingAddress

public CS1ConnectArg setDestinationRoutingAddress(CalledPartyNumber[] value)
                                           throws IllegalStateException

Sets the value of the field destinationRoutingAddress.

Overrides:

setDestinationRoutingAddress in class CCConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setExtensions

public CS1ConnectArg setExtensions(CS1ExtensionField[] 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

setOriginalCalledPartyID

public CS1ConnectArg setOriginalCalledPartyID(OriginalCalledNumber value)
                                       throws IllegalStateException

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

Overrides:

setOriginalCalledPartyID in class CCConnectArg

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 CCConnectArg

setRedirectingPartyID

public CS1ConnectArg setRedirectingPartyID(RedirectingPartyNumber value)
                                    throws IllegalStateException

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

Overrides:

setRedirectingPartyID in class CCConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setRedirectionInformation

public CS1ConnectArg setRedirectionInformation(RedirectionInformation value)
                                        throws IllegalStateException

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

Overrides:

setRedirectionInformation in class CCConnectArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setRouteList

public CS1ConnectArg setRouteList(byte[][] value)
                           throws IllegalStateException

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

setScfID

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

setServiceInteractionIndicators

public CS1ConnectArg setServiceInteractionIndicators(CS1ServiceInteractionIndicators value)
                                              throws IllegalStateException

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