com.opencloud.slee.resources.cgin.cap_v3

Class CAP3EventReportSMSArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CAP3EventReportSMSArg

All Implemented Interfaces:

DataObject, Serializable

public class CAP3EventReportSMSArg
extends AbstractFieldsObject

API for CAP-SMS-ops-args.EventReportSMSArg. Generated from the following ASN.1 type definition.

 EventReportSMSArg ::=
     SEQUENCE {
         eventTypeSMS                EventTypeSMS,
         eventSpecificInformationSMS EventSpecificInformationSMS OPTIONAL,
         miscCallInfo                MiscCallInfo DEFAULT {
           messageType request
         },
         extensions                  Extensions OPTIONAL,
         ...
     }
 

Used as argument type by CAP3Operations.eventReportSMS.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CAP3EventReportSMSArg	clone() Constructs a copy of this object and everything reachable from it.
static CAP3EventReportSMSArg	copyOf(CAP3EventReportSMSArg 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.
CAP3EventSpecificInformationSMS	getEventSpecificInformationSMS() Gets the value of the field eventSpecificInformationSMS.
CAP3EventTypeSMS	getEventTypeSMS() Gets the value of the field eventTypeSMS.
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.
CCMiscCallInfo	getMiscCallInfo() Gets the value of the field miscCallInfo.
boolean	hasEventSpecificInformationSMS() Tests whether the field eventSpecificInformationSMS has a value.
boolean	hasEventTypeSMS() Tests whether the field eventTypeSMS has a value.
boolean	hasExtensions() Tests whether the field extensions has a value.
boolean	hasMiscCallInfo() Tests whether the field miscCallInfo has a value.
CAP3EventReportSMSArg	setEventSpecificInformationSMS(CAP3EventSpecificInformationSMS value) Sets the value of the field eventSpecificInformationSMS.
CAP3EventReportSMSArg	setEventTypeSMS(CAP3EventTypeSMS value) Sets the value of the field eventTypeSMS.
CAP3EventReportSMSArg	setExtensions(CAP1ExtensionField[] value) Sets the value of the field extensions.
CAP3EventReportSMSArg	setMiscCallInfo(CCMiscCallInfo value) Sets the value of the field miscCallInfo.
void	setReadOnly() Sets this and all its fields to be immutable.

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

CAP3EventReportSMSArg

public CAP3EventReportSMSArg()

Constructs an object with uninitialised state.

Method Detail

clone

public CAP3EventReportSMSArg 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 CAP3EventReportSMSArg copyOf(CAP3EventReportSMSArg 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:

CAP3EventReportSMSArg

getEventSpecificInformationSMS

public CAP3EventSpecificInformationSMS getEventSpecificInformationSMS()

Gets the value of the field eventSpecificInformationSMS.

Returns:

value of field eventSpecificInformationSMS, or null if not present

getEventTypeSMS

public CAP3EventTypeSMS getEventTypeSMS()

Gets the value of the field eventTypeSMS.

Returns:

value of field eventTypeSMS, or null if not present

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.

Specified by:

getFieldsMap in class AbstractFieldsObject

Parameters:

withAbsents - whether to put absent optional fields into Map

Returns:

Map from field-name to field-value

getMiscCallInfo

public CCMiscCallInfo getMiscCallInfo()

Gets the value of the field miscCallInfo.

Returns:

value of field miscCallInfo, or null if not present

hasEventSpecificInformationSMS

public boolean hasEventSpecificInformationSMS()

Tests whether the field eventSpecificInformationSMS has a value.

Returns:

whether the field eventSpecificInformationSMS has a value

hasEventTypeSMS

public boolean hasEventTypeSMS()

Tests whether the field eventTypeSMS has a value.

Returns:

whether the field eventTypeSMS has a value

hasExtensions

public boolean hasExtensions()

Tests whether the field extensions has a value.

Returns:

whether the field extensions has a value

hasMiscCallInfo

public boolean hasMiscCallInfo()

Tests whether the field miscCallInfo has a value.

Returns:

whether the field miscCallInfo has a value

setEventSpecificInformationSMS

public CAP3EventReportSMSArg setEventSpecificInformationSMS(CAP3EventSpecificInformationSMS value)
                                                     throws IllegalStateException

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

setEventTypeSMS

public CAP3EventReportSMSArg setEventTypeSMS(CAP3EventTypeSMS value)
                                      throws IllegalStateException

Sets the value of the field eventTypeSMS.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setExtensions

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

setMiscCallInfo

public CAP3EventReportSMSArg setMiscCallInfo(CCMiscCallInfo value)
                                      throws IllegalStateException

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

setReadOnly

public void setReadOnly()

Sets this and all its fields to be immutable.

Specified by:

setReadOnly in interface DataObject

Overrides:

setReadOnly in class AbstractDataObject