com.opencloud.slee.resources.cgin.etsi_inap_cs1

Class CS1PromptAndCollectUserInformationArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CCPromptAndCollectUserInformationArg

CS1PromptAndCollectUserInformationArg

All Implemented Interfaces:

DataObject, Serializable

public class CS1PromptAndCollectUserInformationArg
extends CCPromptAndCollectUserInformationArg

API for Core-INAP-CS1-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..1000)) OF ExtensionField OPTIONAL,
         ...
     }
 Core-INAP-CS1-DataTypes {
     PromptAndCollectUserInformationArg {
         @parentType com.opencloud.slee.resources.cgin.callcontrol.CCPromptAndCollectUserInformationArg
     }
 }
 

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

Method Summary

Methods

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

Methods inherited from class CCPromptAndCollectUserInformationArg

getCollectedInfo, getDisconnectFromIPForbidden, getInformationToSend, hasCollectedInfo, hasDisconnectFromIPForbidden, hasInformationToSend, setInformationToSend, 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

CS1PromptAndCollectUserInformationArg

public CS1PromptAndCollectUserInformationArg()

Constructs an object with uninitialised state.

Method Detail

clone

public CS1PromptAndCollectUserInformationArg 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 CS1PromptAndCollectUserInformationArg 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:

CS1PromptAndCollectUserInformationArg

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 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 CS1PromptAndCollectUserInformationArg 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 CS1PromptAndCollectUserInformationArg 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 CS1PromptAndCollectUserInformationArg 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 CS1PromptAndCollectUserInformationArg 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

setInformationToSend

public CS1PromptAndCollectUserInformationArg setInformationToSend(CS1InformationToSend value)
                                                           throws IllegalStateException

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