com.opencloud.slee.resources.cgin.cap_v3

Class CAP3ConnectSMSArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CAP3ConnectSMSArg

All Implemented Interfaces:

DataObject, Serializable

public class CAP3ConnectSMSArg
extends AbstractFieldsObject

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

 ConnectSMSArg ::=
     SEQUENCE {
         callingPartysNumber         ISDN-AddressString OPTIONAL,
         destinationSubscriberNumber CalledPartyBCDNumber OPTIONAL,
         sMSCAddress                 ISDN-AddressString OPTIONAL,
         extensions                  Extensions OPTIONAL,
         ...
     }
 

Used as argument type by CAP3Operations.connectSMS.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CAP3ConnectSMSArg	clone() Constructs a copy of this object and everything reachable from it.
static CAP3ConnectSMSArg	copyOf(CAP3ConnectSMSArg 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.
AddressString	getCallingPartysNumber() Gets the value of the field callingPartysNumber.
CalledPartyBCDNumber	getDestinationSubscriberNumber() Gets the value of the field destinationSubscriberNumber.
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.
AddressString	getSMSCAddress() Gets the value of the field sMSCAddress.
boolean	hasCallingPartysNumber() Tests whether the field callingPartysNumber has a value.
boolean	hasDestinationSubscriberNumber() Tests whether the field destinationSubscriberNumber has a value.
boolean	hasExtensions() Tests whether the field extensions has a value.
boolean	hasSMSCAddress() Tests whether the field sMSCAddress has a value.
CAP3ConnectSMSArg	setCallingPartysNumber(AddressString value) Sets the value of the field callingPartysNumber.
CAP3ConnectSMSArg	setDestinationSubscriberNumber(CalledPartyBCDNumber value) Sets the value of the field destinationSubscriberNumber.
CAP3ConnectSMSArg	setExtensions(CAP1ExtensionField[] value) Sets the value of the field extensions.
void	setReadOnly() Sets this and all its fields to be immutable.
CAP3ConnectSMSArg	setSMSCAddress(AddressString value) Sets the value of the field sMSCAddress.

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

CAP3ConnectSMSArg

public CAP3ConnectSMSArg()

Constructs an object with uninitialised state.

Method Detail

clone

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

CAP3ConnectSMSArg

getCallingPartysNumber

public AddressString getCallingPartysNumber()

Gets the value of the field callingPartysNumber.

Returns:

value of field callingPartysNumber, or null if not present

getDestinationSubscriberNumber

public CalledPartyBCDNumber getDestinationSubscriberNumber()

Gets the value of the field destinationSubscriberNumber.

Returns:

value of field destinationSubscriberNumber, 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

getSMSCAddress

public AddressString getSMSCAddress()

Gets the value of the field sMSCAddress.

Returns:

value of field sMSCAddress, or null if not present

hasCallingPartysNumber

public boolean hasCallingPartysNumber()

Tests whether the field callingPartysNumber has a value.

Returns:

whether the field callingPartysNumber has a value

hasDestinationSubscriberNumber

public boolean hasDestinationSubscriberNumber()

Tests whether the field destinationSubscriberNumber has a value.

Returns:

whether the field destinationSubscriberNumber has a value

hasExtensions

public boolean hasExtensions()

Tests whether the field extensions has a value.

Returns:

whether the field extensions has a value

hasSMSCAddress

public boolean hasSMSCAddress()

Tests whether the field sMSCAddress has a value.

Returns:

whether the field sMSCAddress has a value

setCallingPartysNumber

public CAP3ConnectSMSArg setCallingPartysNumber(AddressString value)
                                         throws IllegalStateException

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

setDestinationSubscriberNumber

public CAP3ConnectSMSArg setDestinationSubscriberNumber(CalledPartyBCDNumber value)
                                                 throws IllegalStateException

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

setExtensions

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

setReadOnly

public void setReadOnly()

Sets this and all its fields to be immutable.

Specified by:

setReadOnly in interface DataObject

Overrides:

setReadOnly in class AbstractDataObject

setSMSCAddress

public CAP3ConnectSMSArg setSMSCAddress(AddressString value)
                                 throws IllegalStateException

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