com.opencloud.slee.resources.cgin.map

Class MAPForwardingFeature

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

MAPForwardingFeature

All Implemented Interfaces:

DataObject, Serializable

Direct Known Subclasses:

MAPExt_ForwFeature

public class MAPForwardingFeature
extends AbstractFieldsObject

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

 ForwardingFeature ::=
     SEQUENCE {
         basicService          BasicServiceCode OPTIONAL,
         ss-Status             SS-Status OPTIONAL,             -- Changed from mandatory to optional between ph1 and ph2.
         forwardedToNumber     ISDN-AddressString OPTIONAL,
         forwardedToSubaddress ISDN-SubaddressString OPTIONAL,
         forwardingOptions     ForwardingOptions OPTIONAL,
         noReplyConditionTime  NoReplyConditionTime OPTIONAL,
         ...
         longForwardedToNumber FTN-AddressString OPTIONAL      -- Added in R99.
     }
 

Present in ph1.

Used in array as field type by MAPForwardingInfo.

Used in array as field type by MAPInterrogateSSRes_v1.

Used in array as field type by MAPInterrogateSS_Res.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
MAPForwardingFeature	clone() Constructs a copy of this object and everything reachable from it.
static MAPForwardingFeature	copyOf(MAPForwardingFeature 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.
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.
ForwardingOptions	getForwardingOptions() Gets the value of the field forwardingOptions.
AddressString	getLongForwardedToNumber() Gets the value of the field longForwardedToNumber.
int	getNoReplyConditionTime() Gets the value of the field noReplyConditionTime.
byte[]	getSs_Status() Gets the value of the field ss-Status.
boolean	hasBasicService() Tests whether the field basicService has a value.
boolean	hasForwardedToNumber() Tests whether the field forwardedToNumber has a value.
boolean	hasForwardedToSubaddress() Tests whether the field forwardedToSubaddress has a value.
boolean	hasForwardingOptions() Tests whether the field forwardingOptions has a value.
boolean	hasLongForwardedToNumber() Tests whether the field longForwardedToNumber has a value.
boolean	hasNoReplyConditionTime() Tests whether the field noReplyConditionTime has a value.
boolean	hasSs_Status() Tests whether the field ss-Status has a value.
MAPForwardingFeature	setBasicService(MAPBasicServiceCode value) Sets the value of the field basicService.
MAPForwardingFeature	setForwardedToNumber(AddressString value) Sets the value of the field forwardedToNumber.
MAPForwardingFeature	setForwardedToSubaddress(ISDNSubaddress value) Sets the value of the field forwardedToSubaddress.
MAPForwardingFeature	setForwardingOptions(ForwardingOptions value) Sets the value of the field forwardingOptions.
MAPForwardingFeature	setLongForwardedToNumber(AddressString value) Sets the value of the field longForwardedToNumber.
MAPForwardingFeature	setNoReplyConditionTime(int value) Sets the value of the field noReplyConditionTime and marks the field as present.
MAPForwardingFeature	setNoReplyConditionTimePresent(boolean flag) Sets the presence or absence of the optional field noReplyConditionTime.
void	setReadOnly() Sets this and all its fields to be immutable.
MAPForwardingFeature	setSs_Status(byte[] value) Sets the value of the field ss-Status.

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

MAPForwardingFeature

public MAPForwardingFeature()

Constructs an object with uninitialised state.

Method Detail

clone

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

MAPForwardingFeature

getBasicService

public MAPBasicServiceCode getBasicService()

Gets the value of the field basicService.

Returns:

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

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

getForwardingOptions

public ForwardingOptions getForwardingOptions()

Gets the value of the field forwardingOptions.

Returns:

value of field forwardingOptions, or null if not present

getLongForwardedToNumber

public AddressString getLongForwardedToNumber()

Gets the value of the field longForwardedToNumber.

Returns:

value of field longForwardedToNumber, or null if not present

getNoReplyConditionTime

public int getNoReplyConditionTime()

Gets the value of the field noReplyConditionTime.

Returns:

value of field noReplyConditionTime

getSs_Status

public byte[] getSs_Status()

Gets the value of the field ss-Status.

Returns:

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

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

hasForwardingOptions

public boolean hasForwardingOptions()

Tests whether the field forwardingOptions has a value.

Returns:

whether the field forwardingOptions has a value

hasLongForwardedToNumber

public boolean hasLongForwardedToNumber()

Tests whether the field longForwardedToNumber has a value.

Returns:

whether the field longForwardedToNumber has a value

hasNoReplyConditionTime

public boolean hasNoReplyConditionTime()

Tests whether the field noReplyConditionTime has a value.

Returns:

whether the field noReplyConditionTime has a value

hasSs_Status

public boolean hasSs_Status()

Tests whether the field ss-Status has a value.

Returns:

whether the field ss-Status has a value

setBasicService

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

setForwardedToNumber

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

setForwardingOptions

public MAPForwardingFeature setForwardingOptions(ForwardingOptions value)
                                          throws IllegalStateException

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

setLongForwardedToNumber

public MAPForwardingFeature setLongForwardedToNumber(AddressString value)
                                              throws IllegalStateException

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

setNoReplyConditionTime

public MAPForwardingFeature 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 MAPForwardingFeature 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_Status

public MAPForwardingFeature setSs_Status(byte[] value)
                                  throws IllegalStateException

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