com.opencloud.slee.resources.cgin.callcontrol

Class CCPlayAnnouncementArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CCPlayAnnouncementArg

All Implemented Interfaces:

DataObject, Serializable

Direct Known Subclasses:

CAP2PlayAnnouncementArg, CS1PlayAnnouncementArg

public class CCPlayAnnouncementArg
extends AbstractFieldsObject

API for CC-DataTypes.PlayAnnouncementArg. Generated from the following ASN.1 type definition.

 PlayAnnouncementArg ::=
     SEQUENCE {
         informationToSend           InformationToSend,
         disconnectFromIPForbidden   BOOLEAN DEFAULT TRUE,
         requestAnnouncementComplete BOOLEAN DEFAULT TRUE
     }
 

Used as argument type by CCOperations.playAnnouncement.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

Constructor and Description
CCPlayAnnouncementArg() Constructs an object with uninitialised state.

Method Summary

Methods

Modifier and Type	Method and Description
CCPlayAnnouncementArg	clone() Constructs a copy of this object and everything reachable from it.
static CCPlayAnnouncementArg	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.
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	getRequestAnnouncementComplete() Gets the value of the field requestAnnouncementComplete.
boolean	hasDisconnectFromIPForbidden() Tests whether the field disconnectFromIPForbidden has a value.
boolean	hasInformationToSend() Tests whether the field informationToSend has a value.
boolean	hasRequestAnnouncementComplete() Tests whether the field requestAnnouncementComplete has a value.
CCPlayAnnouncementArg	setDisconnectFromIPForbidden(boolean value) Sets the value of the field disconnectFromIPForbidden and marks the field as present.
CCPlayAnnouncementArg	setDisconnectFromIPForbiddenPresent(boolean flag) Sets the presence or absence of the optional field disconnectFromIPForbidden.
CCPlayAnnouncementArg	setInformationToSend(CCInformationToSend value) Sets the value of the field informationToSend.
void	setReadOnly() Sets this and all its fields to be immutable.
CCPlayAnnouncementArg	setRequestAnnouncementComplete(boolean value) Sets the value of the field requestAnnouncementComplete and marks the field as present.
CCPlayAnnouncementArg	setRequestAnnouncementCompletePresent(boolean flag) Sets the presence or absence of the optional field requestAnnouncementComplete.

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

CCPlayAnnouncementArg

public CCPlayAnnouncementArg()

Constructs an object with uninitialised state.

Method Detail

clone

public CCPlayAnnouncementArg clone()

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

Specified by:

clone in interface DataObject

Specified by:

clone in class AbstractDataObject

Returns:

copy of object

copyOf

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

CCPlayAnnouncementArg

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 class AbstractFieldsObject

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

getRequestAnnouncementComplete

public boolean getRequestAnnouncementComplete()

Gets the value of the field requestAnnouncementComplete.

Returns:

value of field requestAnnouncementComplete

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

hasRequestAnnouncementComplete

public boolean hasRequestAnnouncementComplete()

Tests whether the field requestAnnouncementComplete has a value.

Returns:

whether the field requestAnnouncementComplete has a value

setDisconnectFromIPForbidden

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

Sets the value of the field informationToSend.

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 interface DataObject

Overrides:

setReadOnly in class AbstractDataObject

setRequestAnnouncementComplete

public CCPlayAnnouncementArg setRequestAnnouncementComplete(boolean value)
                                                     throws IllegalStateException

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

setRequestAnnouncementCompletePresent

public CCPlayAnnouncementArg setRequestAnnouncementCompletePresent(boolean flag)
                                                            throws IllegalStateException

Sets the presence or absence of the optional field requestAnnouncementComplete.

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