com.opencloud.slee.resources.cgin.map

Class MAPRegisterSS_Arg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

MAPRegisterSS_Arg

All Implemented Interfaces:

DataObject, Serializable

public class MAPRegisterSS_Arg
extends AbstractFieldsObject

API for MAP-SS-DataTypes.RegisterSS-Arg. Generated from the following ASN.1 type definition.

 RegisterSS-Arg ::=
     SEQUENCE {
         ss-Code               SS-Code,
         basicService          BasicServiceCode OPTIONAL,
         forwardedToNumber     AddressString OPTIONAL,         -- forwardedToNumber should be no more than 10 octets if ph1, else 20 octets.
         forwardedToSubaddress ISDN-SubaddressString OPTIONAL, -- Added in ph2.
         noReplyConditionTime  NoReplyConditionTime OPTIONAL,
         ...
         defaultPriority       EMLPP-Priority OPTIONAL,        -- Added in ph2.
         nbrUser               MC-Bearers OPTIONAL,            -- Added in R99.
         longFTN-Supported     NULL OPTIONAL                   -- Added in R99.
     }
 

Present in ph1. Renamed from RegisterSSArg between ph1 and ph2.

Used as argument type by MAPOperations.registerSS_v1.

Used as argument type by MAPOperations.registerSS.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
MAPRegisterSS_Arg	clone() Constructs a copy of this object and everything reachable from it.
static MAPRegisterSS_Arg	copyOf(MAPRegisterSS_Arg 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.
MAPBasicServiceCode	getBasicService() Gets the value of the field basicService.
int	getDefaultPriority() Gets the value of the field defaultPriority.
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	getForwardedToNumber() Gets the value of the field forwardedToNumber.
ISDNSubaddress	getForwardedToSubaddress() Gets the value of the field forwardedToSubaddress.
int	getNbrUser() Gets the value of the field nbrUser.
int	getNoReplyConditionTime() Gets the value of the field noReplyConditionTime.
SSCode	getSs_Code() Gets the value of the field ss-Code.
boolean	hasBasicService() Tests whether the field basicService has a value.
boolean	hasDefaultPriority() Tests whether the field defaultPriority has a value.
boolean	hasForwardedToNumber() Tests whether the field forwardedToNumber has a value.
boolean	hasForwardedToSubaddress() Tests whether the field forwardedToSubaddress has a value.
boolean	hasLongFTN_Supported() Tests whether the field longFTN-Supported is present.
boolean	hasNbrUser() Tests whether the field nbrUser has a value.
boolean	hasNoReplyConditionTime() Tests whether the field noReplyConditionTime has a value.
boolean	hasSs_Code() Tests whether the field ss-Code has a value.
MAPRegisterSS_Arg	setBasicService(MAPBasicServiceCode value) Sets the value of the field basicService.
MAPRegisterSS_Arg	setDefaultPriority(int value) Sets the value of the field defaultPriority and marks the field as present.
MAPRegisterSS_Arg	setDefaultPriorityPresent(boolean flag) Sets the presence or absence of the optional field defaultPriority.
MAPRegisterSS_Arg	setForwardedToNumber(AddressString value) Sets the value of the field forwardedToNumber.
MAPRegisterSS_Arg	setForwardedToSubaddress(ISDNSubaddress value) Sets the value of the field forwardedToSubaddress.
MAPRegisterSS_Arg	setLongFTN_SupportedPresent(boolean flag) Sets the presence or absence of the optional field longFTN-Supported.
MAPRegisterSS_Arg	setNbrUser(int value) Sets the value of the field nbrUser and marks the field as present.
MAPRegisterSS_Arg	setNbrUserPresent(boolean flag) Sets the presence or absence of the optional field nbrUser.
MAPRegisterSS_Arg	setNoReplyConditionTime(int value) Sets the value of the field noReplyConditionTime and marks the field as present.
MAPRegisterSS_Arg	setNoReplyConditionTimePresent(boolean flag) Sets the presence or absence of the optional field noReplyConditionTime.
void	setReadOnly() Sets this and all its fields to be immutable.
MAPRegisterSS_Arg	setSs_Code(SSCode value) Sets the value of the field ss-Code.

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

MAPRegisterSS_Arg

public MAPRegisterSS_Arg()

Constructs an object with uninitialised state.

Method Detail

clone

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

MAPRegisterSS_Arg

getBasicService

public MAPBasicServiceCode getBasicService()

Gets the value of the field basicService.

Returns:

value of field basicService, or null if not present

getDefaultPriority

public int getDefaultPriority()

Gets the value of the field defaultPriority.

Returns:

value of field defaultPriority

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

getForwardedToNumber

public AddressString getForwardedToNumber()

Gets the value of the field forwardedToNumber.

Returns:

value of field forwardedToNumber, or null if not present

getForwardedToSubaddress

public ISDNSubaddress getForwardedToSubaddress()

Gets the value of the field forwardedToSubaddress.

Returns:

value of field forwardedToSubaddress, or null if not present

getNbrUser

public int getNbrUser()

Gets the value of the field nbrUser.

Returns:

value of field nbrUser

getNoReplyConditionTime

public int getNoReplyConditionTime()

Gets the value of the field noReplyConditionTime.

Returns:

value of field noReplyConditionTime

getSs_Code

public SSCode getSs_Code()

Gets the value of the field ss-Code.

Returns:

value of field ss-Code, or null if not present

hasBasicService

public boolean hasBasicService()

Tests whether the field basicService has a value.

Returns:

whether the field basicService has a value

hasDefaultPriority

public boolean hasDefaultPriority()

Tests whether the field defaultPriority has a value.

Returns:

whether the field defaultPriority has a value

hasForwardedToNumber

public boolean hasForwardedToNumber()

Tests whether the field forwardedToNumber has a value.

Returns:

whether the field forwardedToNumber has a value

hasForwardedToSubaddress

public boolean hasForwardedToSubaddress()

Tests whether the field forwardedToSubaddress has a value.

Returns:

whether the field forwardedToSubaddress has a value

hasLongFTN_Supported

public boolean hasLongFTN_Supported()

Tests whether the field longFTN-Supported is present.

Returns:

whether the field longFTN-Supported is present

hasNbrUser

public boolean hasNbrUser()

Tests whether the field nbrUser has a value.

Returns:

whether the field nbrUser has a value

hasNoReplyConditionTime

public boolean hasNoReplyConditionTime()

Tests whether the field noReplyConditionTime has a value.

Returns:

whether the field noReplyConditionTime has a value

hasSs_Code

public boolean hasSs_Code()

Tests whether the field ss-Code has a value.

Returns:

whether the field ss-Code has a value

setBasicService

public MAPRegisterSS_Arg setBasicService(MAPBasicServiceCode value)
                                  throws IllegalStateException

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

setDefaultPriority

public MAPRegisterSS_Arg setDefaultPriority(int value)
                                     throws IllegalStateException

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

setDefaultPriorityPresent

public MAPRegisterSS_Arg setDefaultPriorityPresent(boolean flag)
                                            throws IllegalStateException

Sets the presence or absence of the optional field defaultPriority.

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

setForwardedToNumber

public MAPRegisterSS_Arg setForwardedToNumber(AddressString value)
                                       throws IllegalStateException

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

setForwardedToSubaddress

public MAPRegisterSS_Arg setForwardedToSubaddress(ISDNSubaddress value)
                                           throws IllegalStateException

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

setLongFTN_SupportedPresent

public MAPRegisterSS_Arg setLongFTN_SupportedPresent(boolean flag)
                                              throws IllegalStateException

Sets the presence or absence of the optional field longFTN-Supported.

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

setNbrUser

public MAPRegisterSS_Arg setNbrUser(int value)
                             throws IllegalStateException

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

setNbrUserPresent

public MAPRegisterSS_Arg setNbrUserPresent(boolean flag)
                                    throws IllegalStateException

Sets the presence or absence of the optional field nbrUser.

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

setNoReplyConditionTime

public MAPRegisterSS_Arg setNoReplyConditionTime(int value)
                                          throws IllegalStateException

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

setNoReplyConditionTimePresent

public MAPRegisterSS_Arg setNoReplyConditionTimePresent(boolean flag)
                                                 throws IllegalStateException

Sets the presence or absence of the optional field noReplyConditionTime.

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

setReadOnly

public void setReadOnly()

Sets this and all its fields to be immutable.

Specified by:

setReadOnly in interface DataObject

Overrides:

setReadOnly in class AbstractDataObject

setSs_Code

public MAPRegisterSS_Arg setSs_Code(SSCode value)
                             throws IllegalStateException

Sets the value of the field ss-Code.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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