Package com.opencloud.slee.resources.cgin.etsi_inap_cs1

Class CS1InformationToSend

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CCInformationToSend

CS1InformationToSend

All Implemented Interfaces:

DataObject, Serializable

public class CS1InformationToSend
extends CCInformationToSend

API for Core-INAP-CS1-DataTypes.InformationToSend. Generated from the following ASN.1 type definition and the adaptations below.

 InformationToSend ::=
     CHOICE {
         inbandinfo         InbandInfo,
         tone               Tone,
         displayInformation DisplayInformation
     }
 Core-INAP-CS1-DataTypes {
     InformationToSend {
         @parentType com.opencloud.slee.resources.cgin.callcontrol.CCInformationToSend
         inbandinfo {
             @rename inbandInfo
         }
     }
 }
 

Used as field type by CS1GapTreatment.

Used as field type by CS1GapTreatment.Both.

Used as field type by CS1PlayAnnouncementArg.

Used as field type by CS1PromptAndCollectUserInformationArg.

Used as field type by CS1FilteredCallTreatment.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CS1InformationToSend.Choice	API for Core-INAP-CS1-DataTypes.InformationToSend.Choice.

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

Constructor	Description
CS1InformationToSend()

Method Summary

Modifier and Type	Method	Description
CS1InformationToSend	clone()	Constructs a copy of this object and everything reachable from it.
static CS1InformationToSend	copyOf(CCInformationToSend 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.
String	getDisplayInformation()	Gets the value of the displayInformation choice.
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 :discriminant-name to associated-value.
boolean	isDisplayInformationChosen()	Tests whether the choice is displayInformation.
CS1InformationToSend	setDisplayInformation(String value)	Sets the value of the displayInformation choice.
CS1InformationToSend	setInbandInfo(CCInbandInfo value)	Sets the value of the inbandinfo choice.
CS1InformationToSend	setTone(CCTone value)	Sets the value of the tone choice.

Methods inherited from class com.opencloud.slee.resources.cgin.callcontrol.CCInformationToSend

getChoice, getInbandInfo, getTone, isInbandInfoChosen, isToneChosen, setChoice, 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

CS1InformationToSend

public CS1InformationToSend()

Method Detail

clone

public CS1InformationToSend clone()

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

Specified by:

clone in interface DataObject

Overrides:

clone in class CCInformationToSend

Returns:

copy of object

copyOf

public static CS1InformationToSend copyOf(CCInformationToSend 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:

CS1InformationToSend

getDisplayInformation

public String getDisplayInformation()

Gets the value of the displayInformation choice.

Returns:

value of the choice, if choice is displayInformation, else null

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 :discriminant-name to associated-value. For a value of primitive type, the value is boxed. If choice is not set, returns a map from : to AbstractFieldsObject.FIELD_UNINITIALISED.

Overrides:

getFieldsMap in class CCInformationToSend

Parameters:

withAbsents - ignored, as value cannot be optional

Returns:

Map from :discriminant-name to associated-value

isDisplayInformationChosen

public boolean isDisplayInformationChosen()

Tests whether the choice is displayInformation.

Returns:

true if chosen, false if not

setDisplayInformation

public CS1InformationToSend setDisplayInformation(String value)
                                           throws IllegalStateException,
                                                  NullPointerException

Sets the value of the displayInformation choice.

Parameters:

value - the new value for the choice

Returns:

this

Throws:

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

NullPointerException - if the given value is null

setInbandInfo

public CS1InformationToSend setInbandInfo(CCInbandInfo value)
                                   throws IllegalStateException,
                                          NullPointerException

Sets the value of the inbandinfo choice.

Overrides:

setInbandInfo in class CCInformationToSend

Parameters:

value - the new value for the choice

Returns:

this

Throws:

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

NullPointerException - if the given value is null

setTone

public CS1InformationToSend setTone(CCTone value)
                             throws IllegalStateException,
                                    NullPointerException

Sets the value of the tone choice.

Overrides:

setTone in class CCInformationToSend

Parameters:

value - the new value for the choice

Returns:

this

Throws:

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

NullPointerException - if the given value is null