Package com.opencloud.slee.resources.cgin.cap_v4

Class CAP4PromptAndCollectUserInformationArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CCPromptAndCollectUserInformationArg

CAP2PromptAndCollectUserInformationArg

CAP4PromptAndCollectUserInformationArg

All Implemented Interfaces:

DataObject, Serializable

public class CAP4PromptAndCollectUserInformationArg
extends CAP2PromptAndCollectUserInformationArg

API for CAP-gsmSCF-gsmSRF-ops-args.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                             Extensions OPTIONAL,
         callSegmentID                          CallSegmentID OPTIONAL,
         requestAnnouncementStartedNotification BOOLEAN DEFAULT FALSE,
         ...
     }
 CAP-gsmSCF-gsmSRF-ops-args {
     PromptAndCollectUserInformationArg {
         @parentType com.opencloud.slee.resources.cgin.cap_v2.CAP2PromptAndCollectUserInformationArg
     }
 }
 

Used as argument type by CAP4Operations.promptAndCollectUserInformation.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

Constructor	Description
CAP4PromptAndCollectUserInformationArg()	Constructs an object with uninitialised state.

Method Summary

Modifier and Type	Method	Description
CAP4PromptAndCollectUserInformationArg	clone()	Constructs a copy of this object and everything reachable from it.
static CAP4PromptAndCollectUserInformationArg	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.
int	getCallSegmentID()	Gets the value of the field callSegmentID.
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	getRequestAnnouncementStartedNotification()	Gets the value of the field requestAnnouncementStartedNotification.
boolean	hasCallSegmentID()	Tests whether the field callSegmentID has a value.
boolean	hasRequestAnnouncementStartedNotification()	Tests whether the field requestAnnouncementStartedNotification has a value.
CAP4PromptAndCollectUserInformationArg	setCallSegmentID(int value)	Sets the value of the field callSegmentID and marks the field as present.
CAP4PromptAndCollectUserInformationArg	setCallSegmentIDPresent(boolean flag)	Sets the presence or absence of the optional field callSegmentID.
CAP4PromptAndCollectUserInformationArg	setCollectedInfo(CCCollectedInfo value)	Sets the value of the field collectedInfo.
CAP4PromptAndCollectUserInformationArg	setDisconnectFromIPForbidden(boolean value)	Sets the value of the field disconnectFromIPForbidden.
CAP4PromptAndCollectUserInformationArg	setDisconnectFromIPForbiddenPresent(boolean flag)	Sets the presence or absence of the optional field disconnectFromIPForbidden.
CAP4PromptAndCollectUserInformationArg	setExtensions(CAP1ExtensionField[] value)	Sets the value of the field extensions.
CAP4PromptAndCollectUserInformationArg	setInformationToSend(CCInformationToSend value)	Sets the value of the field informationToSend.
CAP4PromptAndCollectUserInformationArg	setRequestAnnouncementStartedNotification(boolean value)	Sets the value of the field requestAnnouncementStartedNotification and marks the field as present.
CAP4PromptAndCollectUserInformationArg	setRequestAnnouncementStartedNotificationPresent(boolean flag)	Sets the presence or absence of the optional field requestAnnouncementStartedNotification.

Methods inherited from class com.opencloud.slee.resources.cgin.cap_v2.CAP2PromptAndCollectUserInformationArg

getExtensions, hasExtensions

Methods inherited from class com.opencloud.slee.resources.cgin.callcontrol.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

CAP4PromptAndCollectUserInformationArg

public CAP4PromptAndCollectUserInformationArg()

Constructs an object with uninitialised state.

Method Detail

clone

public CAP4PromptAndCollectUserInformationArg clone()

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

Specified by:

clone in interface DataObject

Overrides:

clone in class CAP2PromptAndCollectUserInformationArg

Returns:

copy of object

copyOf

public static CAP4PromptAndCollectUserInformationArg 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:

CAP4PromptAndCollectUserInformationArg

getCallSegmentID

public int getCallSegmentID()

Gets the value of the field callSegmentID.

Returns:

value of field callSegmentID

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 CAP2PromptAndCollectUserInformationArg

Parameters:

withAbsents - whether to put absent optional fields into Map

Returns:

Map from field-name to field-value

getRequestAnnouncementStartedNotification

public boolean getRequestAnnouncementStartedNotification()

Gets the value of the field requestAnnouncementStartedNotification.

Returns:

value of field requestAnnouncementStartedNotification

hasCallSegmentID

public boolean hasCallSegmentID()

Tests whether the field callSegmentID has a value.

Returns:

whether the field callSegmentID has a value

hasRequestAnnouncementStartedNotification

public boolean hasRequestAnnouncementStartedNotification()

Tests whether the field requestAnnouncementStartedNotification has a value.

Returns:

whether the field requestAnnouncementStartedNotification has a value

setCallSegmentID

public CAP4PromptAndCollectUserInformationArg setCallSegmentID(int value)
                                                        throws IllegalStateException

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

setCallSegmentIDPresent

public CAP4PromptAndCollectUserInformationArg setCallSegmentIDPresent(boolean flag)
                                                               throws IllegalStateException

Sets the presence or absence of the optional field callSegmentID.

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

setCollectedInfo

public CAP4PromptAndCollectUserInformationArg setCollectedInfo(CCCollectedInfo value)
                                                        throws IllegalStateException

Sets the value of the field collectedInfo.

Overrides:

setCollectedInfo in class CAP2PromptAndCollectUserInformationArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setDisconnectFromIPForbidden

public CAP4PromptAndCollectUserInformationArg setDisconnectFromIPForbidden(boolean value)
                                                                    throws IllegalStateException

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

Overrides:

setDisconnectFromIPForbidden in class CAP2PromptAndCollectUserInformationArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setDisconnectFromIPForbiddenPresent

public CAP4PromptAndCollectUserInformationArg setDisconnectFromIPForbiddenPresent(boolean flag)
                                                                           throws IllegalStateException

Sets the presence or absence of the optional field disconnectFromIPForbidden.

Overrides:

setDisconnectFromIPForbiddenPresent in class CAP2PromptAndCollectUserInformationArg

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 CAP4PromptAndCollectUserInformationArg setExtensions(CAP1ExtensionField[] value)
                                                     throws IllegalStateException

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

Overrides:

setExtensions in class CAP2PromptAndCollectUserInformationArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setInformationToSend

public CAP4PromptAndCollectUserInformationArg setInformationToSend(CCInformationToSend value)
                                                            throws IllegalStateException

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

Overrides:

setInformationToSend in class CAP2PromptAndCollectUserInformationArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setRequestAnnouncementStartedNotification

public CAP4PromptAndCollectUserInformationArg setRequestAnnouncementStartedNotification(boolean value)
                                                                                 throws IllegalStateException

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

setRequestAnnouncementStartedNotificationPresent

public CAP4PromptAndCollectUserInformationArg setRequestAnnouncementStartedNotificationPresent(boolean flag)
                                                                                        throws IllegalStateException

Sets the presence or absence of the optional field requestAnnouncementStartedNotification.

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