Class CCPromptAndCollectUserInformationArg
- java.lang.Object
-
- com.opencloud.util.AbstractDataObject
-
- com.opencloud.util.AbstractFieldsObject
-
- CCPromptAndCollectUserInformationArg
-
- All Implemented Interfaces:
DataObject
,Serializable
- Direct Known Subclasses:
CAP2PromptAndCollectUserInformationArg
,CS1PromptAndCollectUserInformationArg
public class CCPromptAndCollectUserInformationArg extends AbstractFieldsObject
API for CC-DataTypes.PromptAndCollectUserInformationArg. Generated from the following ASN.1 type definition.PromptAndCollectUserInformationArg ::= SEQUENCE { collectedInfo CollectedInfo, disconnectFromIPForbidden BOOLEAN DEFAULT TRUE, informationToSend InformationToSend OPTIONAL }
Used as argument type by
CCOperations.promptAndCollectUserInformation
.- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.opencloud.util.AbstractFieldsObject
FIELD_ABSENT, FIELD_UNINITIALISED
-
-
Constructor Summary
Constructors Constructor Description CCPromptAndCollectUserInformationArg()
Constructs an object with uninitialised state.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description CCPromptAndCollectUserInformationArg
clone()
Constructs a copy of this object and everything reachable from it.static CCPromptAndCollectUserInformationArg
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.CCCollectedInfo
getCollectedInfo()
Gets the value of the field collectedInfo.boolean
getDisconnectFromIPForbidden()
Gets the value of the field disconnectFromIPForbidden.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.CCInformationToSend
getInformationToSend()
Gets the value of the field informationToSend.boolean
hasCollectedInfo()
Tests whether the field collectedInfo has a value.boolean
hasDisconnectFromIPForbidden()
Tests whether the field disconnectFromIPForbidden has a value.boolean
hasInformationToSend()
Tests whether the field informationToSend has a value.CCPromptAndCollectUserInformationArg
setCollectedInfo(CCCollectedInfo value)
Sets the value of the field collectedInfo.CCPromptAndCollectUserInformationArg
setDisconnectFromIPForbidden(boolean value)
Sets the value of the field disconnectFromIPForbidden and marks the field as present.CCPromptAndCollectUserInformationArg
setDisconnectFromIPForbiddenPresent(boolean flag)
Sets the presence or absence of the optional field disconnectFromIPForbidden.CCPromptAndCollectUserInformationArg
setInformationToSend(CCInformationToSend value)
Sets the value of the field informationToSend.void
setReadOnly()
Sets this and all its fields to be immutable.-
Methods inherited from class com.opencloud.util.AbstractFieldsObject
equals, hashCode, toString
-
Methods inherited from class com.opencloud.util.AbstractDataObject
checkModify, isReadOnly
-
-
-
-
Method Detail
-
clone
public CCPromptAndCollectUserInformationArg clone()
Constructs a copy of this object and everything reachable from it.- Specified by:
clone
in interfaceDataObject
- Specified by:
clone
in classAbstractDataObject
- Returns:
- copy of object
-
copyOf
public static CCPromptAndCollectUserInformationArg 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:
- CCPromptAndCollectUserInformationArg
-
getCollectedInfo
public CCCollectedInfo getCollectedInfo()
Gets the value of the field collectedInfo.- Returns:
- value of field collectedInfo, or null if not present
-
getDisconnectFromIPForbidden
public boolean getDisconnectFromIPForbidden()
Gets the value of the field disconnectFromIPForbidden.- Returns:
- value of field disconnectFromIPForbidden
-
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 classAbstractFieldsObject
- Parameters:
withAbsents
- whether to put absent optional fields into Map- Returns:
- Map from field-name to field-value
-
getInformationToSend
public CCInformationToSend getInformationToSend()
Gets the value of the field informationToSend.- Returns:
- value of field informationToSend, or null if not present
-
hasCollectedInfo
public boolean hasCollectedInfo()
Tests whether the field collectedInfo has a value.- Returns:
- whether the field collectedInfo has a value
-
hasDisconnectFromIPForbidden
public boolean hasDisconnectFromIPForbidden()
Tests whether the field disconnectFromIPForbidden has a value.- Returns:
- whether the field disconnectFromIPForbidden has a value
-
hasInformationToSend
public boolean hasInformationToSend()
Tests whether the field informationToSend has a value.- Returns:
- whether the field informationToSend has a value
-
setCollectedInfo
public CCPromptAndCollectUserInformationArg setCollectedInfo(CCCollectedInfo value) throws IllegalStateException
Sets the value of the field collectedInfo.- Parameters:
value
- the new value for the field- Returns:
- this
- Throws:
IllegalStateException
- if this instance has been marked as read-only
-
setDisconnectFromIPForbidden
public CCPromptAndCollectUserInformationArg setDisconnectFromIPForbidden(boolean value) throws IllegalStateException
Sets the value of the field disconnectFromIPForbidden 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
-
setDisconnectFromIPForbiddenPresent
public CCPromptAndCollectUserInformationArg setDisconnectFromIPForbiddenPresent(boolean flag) throws IllegalStateException
Sets the presence or absence of the optional field disconnectFromIPForbidden.- 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
-
setInformationToSend
public CCPromptAndCollectUserInformationArg setInformationToSend(CCInformationToSend 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
-
setReadOnly
public void setReadOnly()
Sets this and all its fields to be immutable.- Specified by:
setReadOnly
in interfaceDataObject
- Overrides:
setReadOnly
in classAbstractDataObject
-
-