com.opencloud.slee.resources.cgin.cap_v2

Class CAP2PromptAndCollectUserInformationArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CCPromptAndCollectUserInformationArg

CAP2PromptAndCollectUserInformationArg

All Implemented Interfaces:

DataObject, Serializable

Direct Known Subclasses:

CAP4PromptAndCollectUserInformationArg

public class CAP2PromptAndCollectUserInformationArg
extends CCPromptAndCollectUserInformationArg

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

 PromptAndCollectUserInformationArg ::=
     SEQUENCE {
         collectedInfo             CollectedInfo,
         disconnectFromIPForbidden BOOLEAN DEFAULT TRUE,
         informationToSend         InformationToSend OPTIONAL,
         extensions                SEQUENCE (SIZE (1..10)) OF ExtensionField OPTIONAL,
         ...
     }
 CAP-DataTypes {
     PromptAndCollectUserInformationArg {
         @parentType com.opencloud.slee.resources.cgin.callcontrol.CCPromptAndCollectUserInformationArg
     }
 }
 

Used as argument type by CAP2Operations.promptAndCollectUserInformation.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CAP2PromptAndCollectUserInformationArg	clone() Constructs a copy of this object and everything reachable from it.
static CAP2PromptAndCollectUserInformationArg	copyOf(CCPromptAndCollectUserInformationArg 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.
boolean	hasExtensions() Tests whether the field extensions has a value.
CAP2PromptAndCollectUserInformationArg	setCollectedInfo(CCCollectedInfo value) Sets the value of the field collectedInfo.
CAP2PromptAndCollectUserInformationArg	setDisconnectFromIPForbidden(boolean value) Sets the value of the field disconnectFromIPForbidden.
CAP2PromptAndCollectUserInformationArg	setDisconnectFromIPForbiddenPresent(boolean flag) Sets the presence or absence of the optional field disconnectFromIPForbidden.
CAP2PromptAndCollectUserInformationArg	setExtensions(CAP1ExtensionField[] value) Sets the value of the field extensions.
CAP2PromptAndCollectUserInformationArg	setInformationToSend(CCInformationToSend value) Sets the value of the field informationToSend.

Methods inherited from class CCPromptAndCollectUserInformationArg

getCollectedInfo, getDisconnectFromIPForbidden, getInformationToSend, hasCollectedInfo, hasDisconnectFromIPForbidden, hasInformationToSend, setReadOnly

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

CAP2PromptAndCollectUserInformationArg

public CAP2PromptAndCollectUserInformationArg()

Constructs an object with uninitialised state.

Method Detail

clone

public CAP2PromptAndCollectUserInformationArg clone()

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

Specified by:

clone in interface DataObject

Overrides:

clone in class CCPromptAndCollectUserInformationArg

Returns:

copy of object

copyOf

public static CAP2PromptAndCollectUserInformationArg copyOf(CCPromptAndCollectUserInformationArg 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:

CAP2PromptAndCollectUserInformationArg

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 CCPromptAndCollectUserInformationArg

Parameters:

withAbsents - whether to put absent optional fields into Map

Returns:

Map from field-name to field-value

hasExtensions

public boolean hasExtensions()

Tests whether the field extensions has a value.

Returns:

whether the field extensions has a value

setCollectedInfo

public CAP2PromptAndCollectUserInformationArg setCollectedInfo(CCCollectedInfo value)
                                                        throws IllegalStateException

Sets the value of the field collectedInfo.

Overrides:

setCollectedInfo in class CCPromptAndCollectUserInformationArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setDisconnectFromIPForbidden

public CAP2PromptAndCollectUserInformationArg setDisconnectFromIPForbidden(boolean value)
                                                                    throws IllegalStateException

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

Overrides:

setDisconnectFromIPForbidden in class CCPromptAndCollectUserInformationArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setDisconnectFromIPForbiddenPresent

public CAP2PromptAndCollectUserInformationArg setDisconnectFromIPForbiddenPresent(boolean flag)
                                                                           throws IllegalStateException

Sets the presence or absence of the optional field disconnectFromIPForbidden.

Overrides:

setDisconnectFromIPForbiddenPresent in class CCPromptAndCollectUserInformationArg

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

setExtensions

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

setInformationToSend

public CAP2PromptAndCollectUserInformationArg setInformationToSend(CCInformationToSend value)
                                                            throws IllegalStateException

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

Overrides:

setInformationToSend in class CCPromptAndCollectUserInformationArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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