com.opencloud.slee.resources.cgin.map

Class MAPForwardingData

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

MAPForwardingData

All Implemented Interfaces:

DataObject, Serializable

public class MAPForwardingData
extends AbstractFieldsObject

API for MAP-CH-DataTypes.ForwardingData. Generated from the following ASN.1 type definition.

 ForwardingData ::=
     SEQUENCE {
         forwardedToNumber     ISDN-AddressString OPTIONAL,    -- Changed from mandatory to optional between ph1 and ph2.  When this datatype is sent from an HLR which supports CAMEL Phase 2 to a GMSC which supports CAMEL Phase 2 the GMSC shall not check the format of the number.
         forwardedToSubaddress ISDN-SubaddressString OPTIONAL, -- Added in ph2.
         forwardingOptions     ForwardingOptions OPTIONAL,
         extensionContainer    ExtensionContainer OPTIONAL,    -- Added in R96.
         ...
         longForwardedToNumber FTN-AddressString OPTIONAL      -- Added in R99.
     }
 

Present in ph1. Moved from MAP-SS-DataTypes between ph2 and R96.

Used as field type by MAPRoutingInfo.

Used as field type by MAPCamelRoutingInfo.

Used as field type by MAPResumeCallHandlingArg.

Used as field type by MAPSendRoutingInfoForSMRes.LocationOrForwarding.

Used as field type by MAPSendRoutingInformationRes.RoutingInfo.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
MAPForwardingData	clone() Constructs a copy of this object and everything reachable from it.
static MAPForwardingData	copyOf(MAPForwardingData 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.
MAPExtensionContainer	getExtensionContainer() Gets the value of the field extensionContainer.
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.
boolean	hasExtensionContainer() Tests whether the field extensionContainer 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.
MAPForwardingData	setExtensionContainer(MAPExtensionContainer value) Sets the value of the field extensionContainer.
MAPForwardingData	setForwardedToNumber(AddressString value) Sets the value of the field forwardedToNumber.
MAPForwardingData	setForwardedToSubaddress(ISDNSubaddress value) Sets the value of the field forwardedToSubaddress.
MAPForwardingData	setForwardingOptions(ForwardingOptions value) Sets the value of the field forwardingOptions.
MAPForwardingData	setLongForwardedToNumber(AddressString value) Sets the value of the field longForwardedToNumber.
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

MAPForwardingData

public MAPForwardingData()

Constructs an object with uninitialised state.

Method Detail

clone

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

MAPForwardingData

getExtensionContainer

public MAPExtensionContainer getExtensionContainer()

Gets the value of the field extensionContainer.

Returns:

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

hasExtensionContainer

public boolean hasExtensionContainer()

Tests whether the field extensionContainer has a value.

Returns:

whether the field extensionContainer 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

setExtensionContainer

public MAPForwardingData setExtensionContainer(MAPExtensionContainer value)
                                        throws IllegalStateException

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

setReadOnly

public void setReadOnly()

Sets this and all its fields to be immutable.

Specified by:

setReadOnly in interface DataObject

Overrides:

setReadOnly in class AbstractDataObject