com.opencloud.slee.resources.cgin.etsi_inap_cs1

Class CS1InitiateCallAttemptArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CS1InitiateCallAttemptArg

All Implemented Interfaces:

DataObject, Serializable

public class CS1InitiateCallAttemptArg
extends AbstractFieldsObject

API for Core-INAP-CS1-DataTypes.InitiateCallAttemptArg. Generated from the following ASN.1 type definition.

 InitiateCallAttemptArg ::=
     SEQUENCE {
         destinationRoutingAddress    DestinationRoutingAddress,
         alertingPattern              AlertingPattern OPTIONAL,
         extensions                   SEQUENCE (SIZE (1..1000)) OF ExtensionField OPTIONAL,
         serviceInteractionIndicators ServiceInteractionIndicators OPTIONAL,
         callingPartyNumber           CallingPartyNumber OPTIONAL,
         ...
     }
 

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

Method Summary

Methods

Modifier and Type	Method and Description
CS1InitiateCallAttemptArg	clone() Constructs a copy of this object and everything reachable from it.
static CS1InitiateCallAttemptArg	copyOf(CS1InitiateCallAttemptArg 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.
Signal	getAlertingPattern() Gets the value of the field alertingPattern.
CallingPartyNumber	getCallingPartyNumber() Gets the value of the field callingPartyNumber.
CalledPartyNumber[]	getDestinationRoutingAddress() Gets the value of the field destinationRoutingAddress.
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.
CS1ServiceInteractionIndicators	getServiceInteractionIndicators() Gets the value of the field serviceInteractionIndicators.
boolean	hasAlertingPattern() Tests whether the field alertingPattern has a value.
boolean	hasCallingPartyNumber() Tests whether the field callingPartyNumber has a value.
boolean	hasDestinationRoutingAddress() Tests whether the field destinationRoutingAddress has a value.
boolean	hasExtensions() Tests whether the field extensions has a value.
boolean	hasServiceInteractionIndicators() Tests whether the field serviceInteractionIndicators has a value.
CS1InitiateCallAttemptArg	setAlertingPattern(Signal value) Sets the value of the field alertingPattern.
CS1InitiateCallAttemptArg	setCallingPartyNumber(CallingPartyNumber value) Sets the value of the field callingPartyNumber.
CS1InitiateCallAttemptArg	setDestinationRoutingAddress(CalledPartyNumber[] value) Sets the value of the field destinationRoutingAddress.
CS1InitiateCallAttemptArg	setExtensions(CS1ExtensionField[] value) Sets the value of the field extensions.
void	setReadOnly() Sets this and all its fields to be immutable.
CS1InitiateCallAttemptArg	setServiceInteractionIndicators(CS1ServiceInteractionIndicators value) Sets the value of the field serviceInteractionIndicators.

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

CS1InitiateCallAttemptArg

public CS1InitiateCallAttemptArg()

Constructs an object with uninitialised state.

Method Detail

clone

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

CS1InitiateCallAttemptArg

getAlertingPattern

public Signal getAlertingPattern()

Gets the value of the field alertingPattern.

Returns:

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

Specified by:

getFieldsMap in class AbstractFieldsObject

Parameters:

withAbsents - whether to put absent optional fields into Map

Returns:

Map from field-name to field-value

getServiceInteractionIndicators

public CS1ServiceInteractionIndicators getServiceInteractionIndicators()

Gets the value of the field serviceInteractionIndicators.

Returns:

value of field serviceInteractionIndicators, or null if not present

hasAlertingPattern

public boolean hasAlertingPattern()

Tests whether the field alertingPattern has a value.

Returns:

whether the field alertingPattern 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

hasServiceInteractionIndicators

public boolean hasServiceInteractionIndicators()

Tests whether the field serviceInteractionIndicators has a value.

Returns:

whether the field serviceInteractionIndicators has a value

setAlertingPattern

public CS1InitiateCallAttemptArg setAlertingPattern(Signal value)
                                             throws IllegalStateException

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

setReadOnly

public void setReadOnly()

Sets this and all its fields to be immutable.

Specified by:

setReadOnly in interface DataObject

Overrides:

setReadOnly in class AbstractDataObject

setServiceInteractionIndicators

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