com.opencloud.slee.resources.cgin.cap_v2

Class CAP2CallInformationRequestArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CCCallInformationRequestArg

CAP2CallInformationRequestArg

All Implemented Interfaces:

DataObject, Serializable

public class CAP2CallInformationRequestArg
extends CCCallInformationRequestArg

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

 CallInformationRequestArg ::=
     SEQUENCE {
         requestedInformationTypeList RequestedInformationTypeList,
         extensions                   SEQUENCE (SIZE (1..10)) OF ExtensionField OPTIONAL,
         legID                        SendingSideID OPTIONAL,
         ...
     }
 CAP-DataTypes {
     CallInformationRequestArg {
         @parentType com.opencloud.slee.resources.cgin.callcontrol.CCCallInformationRequestArg
     }
 }
 

Used as argument type by CAP2Operations.callInformationRequest.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CAP2CallInformationRequestArg	clone() Constructs a copy of this object and everything reachable from it.
static CAP2CallInformationRequestArg	copyOf(CCCallInformationRequestArg 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.
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.
CCLegID	getLegID() Gets the value of the field legID.
boolean	hasExtensions() Tests whether the field extensions has a value.
boolean	hasLegID() Tests whether the field legID has a value.
CAP2CallInformationRequestArg	setExtensions(CAP1ExtensionField[] value) Sets the value of the field extensions.
CAP2CallInformationRequestArg	setLegID(CCLegID value) Sets the value of the field legID.
void	setReadOnly() Sets this and all its fields to be immutable.
CAP2CallInformationRequestArg	setRequestedInformationTypeList(CCRequestedInformationType[] value) Sets the value of the field requestedInformationTypeList.

Methods inherited from class CCCallInformationRequestArg

getRequestedInformationTypeList, hasRequestedInformationTypeList

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

CAP2CallInformationRequestArg

public CAP2CallInformationRequestArg()

Constructs an object with uninitialised state.

Method Detail

clone

public CAP2CallInformationRequestArg clone()

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

Specified by:

clone in interface DataObject

Overrides:

clone in class CCCallInformationRequestArg

Returns:

copy of object

copyOf

public static CAP2CallInformationRequestArg copyOf(CCCallInformationRequestArg 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:

CAP2CallInformationRequestArg

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.

Overrides:

getFieldsMap in class CCCallInformationRequestArg

Parameters:

withAbsents - whether to put absent optional fields into Map

Returns:

Map from field-name to field-value

getLegID

public CCLegID getLegID()

Gets the value of the field legID.

Returns:

value of field legID, or null if not present

hasExtensions

public boolean hasExtensions()

Tests whether the field extensions has a value.

Returns:

whether the field extensions has a value

hasLegID

public boolean hasLegID()

Tests whether the field legID has a value.

Returns:

whether the field legID has a value

setExtensions

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

setLegID

public CAP2CallInformationRequestArg setLegID(CCLegID value)
                                       throws IllegalStateException

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

setRequestedInformationTypeList

public CAP2CallInformationRequestArg setRequestedInformationTypeList(CCRequestedInformationType[] value)
                                                              throws IllegalStateException

Sets the value of the field requestedInformationTypeList.

Overrides:

setRequestedInformationTypeList in class CCCallInformationRequestArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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