Package com.opencloud.slee.resources.cgin.cap_v2

Class CAP2PlayAnnouncementArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CCPlayAnnouncementArg

CAP2PlayAnnouncementArg

All Implemented Interfaces:

DataObject, Serializable

Direct Known Subclasses:

CAP4PlayAnnouncementArg

public class CAP2PlayAnnouncementArg
extends CCPlayAnnouncementArg

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

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

Used as argument type by CAP2Operations.playAnnouncement.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
CAP2PlayAnnouncementArg	clone()	Constructs a copy of this object and everything reachable from it.
static CAP2PlayAnnouncementArg	copyOf(CCPlayAnnouncementArg 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.
CAP2PlayAnnouncementArg	setDisconnectFromIPForbidden(boolean value)	Sets the value of the field disconnectFromIPForbidden.
CAP2PlayAnnouncementArg	setDisconnectFromIPForbiddenPresent(boolean flag)	Sets the presence or absence of the optional field disconnectFromIPForbidden.
CAP2PlayAnnouncementArg	setExtensions(CAP1ExtensionField[] value)	Sets the value of the field extensions.
CAP2PlayAnnouncementArg	setInformationToSend(CCInformationToSend value)	Sets the value of the field informationToSend.
CAP2PlayAnnouncementArg	setRequestAnnouncementComplete(boolean value)	Sets the value of the field requestAnnouncementComplete.
CAP2PlayAnnouncementArg	setRequestAnnouncementCompletePresent(boolean flag)	Sets the presence or absence of the optional field requestAnnouncementComplete.

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

getDisconnectFromIPForbidden, getInformationToSend, getRequestAnnouncementComplete, hasDisconnectFromIPForbidden, hasInformationToSend, hasRequestAnnouncementComplete, 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

CAP2PlayAnnouncementArg

public CAP2PlayAnnouncementArg()

Constructs an object with uninitialised state.

Method Detail

clone

public CAP2PlayAnnouncementArg clone()

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

Specified by:

clone in interface DataObject

Overrides:

clone in class CCPlayAnnouncementArg

Returns:

copy of object

copyOf

public static CAP2PlayAnnouncementArg copyOf(CCPlayAnnouncementArg 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:

CAP2PlayAnnouncementArg

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 CCPlayAnnouncementArg

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

setDisconnectFromIPForbidden

public CAP2PlayAnnouncementArg setDisconnectFromIPForbidden(boolean value)
                                                     throws IllegalStateException

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

Overrides:

setDisconnectFromIPForbidden in class CCPlayAnnouncementArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setDisconnectFromIPForbiddenPresent

public CAP2PlayAnnouncementArg setDisconnectFromIPForbiddenPresent(boolean flag)
                                                            throws IllegalStateException

Sets the presence or absence of the optional field disconnectFromIPForbidden.

Overrides:

setDisconnectFromIPForbiddenPresent in class CCPlayAnnouncementArg

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 CAP2PlayAnnouncementArg 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 CAP2PlayAnnouncementArg setInformationToSend(CCInformationToSend value)
                                             throws IllegalStateException

Sets the value of the field informationToSend.

Overrides:

setInformationToSend in class CCPlayAnnouncementArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setRequestAnnouncementComplete

public CAP2PlayAnnouncementArg setRequestAnnouncementComplete(boolean value)
                                                       throws IllegalStateException

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

Overrides:

setRequestAnnouncementComplete in class CCPlayAnnouncementArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setRequestAnnouncementCompletePresent

public CAP2PlayAnnouncementArg setRequestAnnouncementCompletePresent(boolean flag)
                                                              throws IllegalStateException

Sets the presence or absence of the optional field requestAnnouncementComplete.

Overrides:

setRequestAnnouncementCompletePresent in class CCPlayAnnouncementArg

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