com.opencloud.slee.resources.cgin.cap_v4

Class CAP4PlayAnnouncementArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CCPlayAnnouncementArg

CAP2PlayAnnouncementArg

CAP4PlayAnnouncementArg

All Implemented Interfaces:

DataObject, Serializable

public class CAP4PlayAnnouncementArg
extends CAP2PlayAnnouncementArg

API for CAP-gsmSCF-gsmSRF-ops-args.PlayAnnouncementArg. Generated from the following ASN.1 type definition and the adaptations below.

 PlayAnnouncementArg ::=
     SEQUENCE {
         informationToSend                       InformationToSend,
         disconnectFromIPForbidden               BOOLEAN DEFAULT TRUE,
         requestAnnouncementCompleteNotification BOOLEAN DEFAULT TRUE,
         extensions                              Extensions OPTIONAL,
         callSegmentID                           CallSegmentID OPTIONAL,
         requestAnnouncementStartedNotification  BOOLEAN DEFAULT FALSE,
         ...
     }
 CAP-gsmSCF-gsmSRF-ops-args {
     PlayAnnouncementArg {
         @parentType com.opencloud.slee.resources.cgin.cap_v2.CAP2PlayAnnouncementArg
         requestAnnouncementCompleteNotification {
             @rename requestAnnouncementComplete
         }
         requestAnnouncementStartedNotification {
             @rename requestAnnouncementStarted
         }
     }
 }
 

Used as argument type by CAP4Operations.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
CAP4PlayAnnouncementArg() Constructs an object with uninitialised state.

Method Summary

Methods

Modifier and Type	Method and Description
CAP4PlayAnnouncementArg	clone() Constructs a copy of this object and everything reachable from it.
static CAP4PlayAnnouncementArg	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.
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	getRequestAnnouncementStarted() Gets the value of the field requestAnnouncementStartedNotification.
boolean	hasCallSegmentID() Tests whether the field callSegmentID has a value.
boolean	hasRequestAnnouncementStarted() Tests whether the field requestAnnouncementStartedNotification has a value.
CAP4PlayAnnouncementArg	setCallSegmentID(int value) Sets the value of the field callSegmentID and marks the field as present.
CAP4PlayAnnouncementArg	setCallSegmentIDPresent(boolean flag) Sets the presence or absence of the optional field callSegmentID.
CAP4PlayAnnouncementArg	setDisconnectFromIPForbidden(boolean value) Sets the value of the field disconnectFromIPForbidden.
CAP4PlayAnnouncementArg	setDisconnectFromIPForbiddenPresent(boolean flag) Sets the presence or absence of the optional field disconnectFromIPForbidden.
CAP4PlayAnnouncementArg	setExtensions(CAP1ExtensionField[] value) Sets the value of the field extensions.
CAP4PlayAnnouncementArg	setInformationToSend(CCInformationToSend value) Sets the value of the field informationToSend.
CAP4PlayAnnouncementArg	setRequestAnnouncementComplete(boolean value) Sets the value of the field requestAnnouncementCompleteNotification.
CAP4PlayAnnouncementArg	setRequestAnnouncementCompletePresent(boolean flag) Sets the presence or absence of the optional field requestAnnouncementCompleteNotification.
CAP4PlayAnnouncementArg	setRequestAnnouncementStarted(boolean value) Sets the value of the field requestAnnouncementStartedNotification and marks the field as present.
CAP4PlayAnnouncementArg	setRequestAnnouncementStartedPresent(boolean flag) Sets the presence or absence of the optional field requestAnnouncementStartedNotification.

Methods inherited from class CAP2PlayAnnouncementArg

getExtensions, hasExtensions

Methods inherited from class 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

CAP4PlayAnnouncementArg

public CAP4PlayAnnouncementArg()

Constructs an object with uninitialised state.

Method Detail

clone

public CAP4PlayAnnouncementArg clone()

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

Specified by:

clone in interface DataObject

Overrides:

clone in class CAP2PlayAnnouncementArg

Returns:

copy of object

copyOf

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

CAP4PlayAnnouncementArg

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 CAP2PlayAnnouncementArg

Parameters:

withAbsents - whether to put absent optional fields into Map

Returns:

Map from field-name to field-value

getRequestAnnouncementStarted

public boolean getRequestAnnouncementStarted()

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

hasRequestAnnouncementStarted

public boolean hasRequestAnnouncementStarted()

Tests whether the field requestAnnouncementStartedNotification has a value.

Returns:

whether the field requestAnnouncementStartedNotification has a value

setCallSegmentID

public CAP4PlayAnnouncementArg 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 CAP4PlayAnnouncementArg 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

setDisconnectFromIPForbidden

public CAP4PlayAnnouncementArg setDisconnectFromIPForbidden(boolean value)
                                                     throws IllegalStateException

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

Overrides:

setDisconnectFromIPForbidden in class CAP2PlayAnnouncementArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setDisconnectFromIPForbiddenPresent

public CAP4PlayAnnouncementArg setDisconnectFromIPForbiddenPresent(boolean flag)
                                                            throws IllegalStateException

Sets the presence or absence of the optional field disconnectFromIPForbidden.

Overrides:

setDisconnectFromIPForbiddenPresent in class CAP2PlayAnnouncementArg

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

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

Overrides:

setExtensions in class CAP2PlayAnnouncementArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setInformationToSend

public CAP4PlayAnnouncementArg setInformationToSend(CCInformationToSend value)
                                             throws IllegalStateException

Sets the value of the field informationToSend.

Overrides:

setInformationToSend in class CAP2PlayAnnouncementArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setRequestAnnouncementComplete

public CAP4PlayAnnouncementArg setRequestAnnouncementComplete(boolean value)
                                                       throws IllegalStateException

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

Overrides:

setRequestAnnouncementComplete in class CAP2PlayAnnouncementArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setRequestAnnouncementCompletePresent

public CAP4PlayAnnouncementArg setRequestAnnouncementCompletePresent(boolean flag)
                                                              throws IllegalStateException

Sets the presence or absence of the optional field requestAnnouncementCompleteNotification.

Overrides:

setRequestAnnouncementCompletePresent in class CAP2PlayAnnouncementArg

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

setRequestAnnouncementStarted

public CAP4PlayAnnouncementArg setRequestAnnouncementStarted(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

setRequestAnnouncementStartedPresent

public CAP4PlayAnnouncementArg setRequestAnnouncementStartedPresent(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