com.opencloud.slee.resources.cgin.map

Class MAPRemoteUserFreeArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

MAPRemoteUserFreeArg

All Implemented Interfaces:

DataObject, Serializable

public class MAPRemoteUserFreeArg
extends AbstractFieldsObject

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

 RemoteUserFreeArg ::=
     SEQUENCE {
         imsi               IMSI,
         callInfo           ExternalSignalInfo,
         ccbs-Feature       CCBS-Feature,
         translatedB-Number ISDN-AddressString,
         replaceB-Number    NULL OPTIONAL,
         alertingPattern    AlertingPattern OPTIONAL,
         extensionContainer ExtensionContainer OPTIONAL,
         ...
     }
 

Added in R97.

Used as argument type by MAPOperations.remoteUserFree.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
MAPRemoteUserFreeArg	clone() Constructs a copy of this object and everything reachable from it.
static MAPRemoteUserFreeArg	copyOf(MAPRemoteUserFreeArg 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.
byte[]	getAlertingPattern() Gets the value of the field alertingPattern.
MAPExternalSignalInfo	getCallInfo() Gets the value of the field callInfo.
MAPCCBS_Feature	getCcbs_Feature() Gets the value of the field ccbs-Feature.
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.
IMSIAddress	getImsi() Gets the value of the field imsi.
AddressString	getTranslatedB_Number() Gets the value of the field translatedB-Number.
boolean	hasAlertingPattern() Tests whether the field alertingPattern has a value.
boolean	hasCallInfo() Tests whether the field callInfo has a value.
boolean	hasCcbs_Feature() Tests whether the field ccbs-Feature has a value.
boolean	hasExtensionContainer() Tests whether the field extensionContainer has a value.
boolean	hasImsi() Tests whether the field imsi has a value.
boolean	hasReplaceB_Number() Tests whether the field replaceB-Number is present.
boolean	hasTranslatedB_Number() Tests whether the field translatedB-Number has a value.
MAPRemoteUserFreeArg	setAlertingPattern(byte[] value) Sets the value of the field alertingPattern.
MAPRemoteUserFreeArg	setCallInfo(MAPExternalSignalInfo value) Sets the value of the field callInfo.
MAPRemoteUserFreeArg	setCcbs_Feature(MAPCCBS_Feature value) Sets the value of the field ccbs-Feature.
MAPRemoteUserFreeArg	setExtensionContainer(MAPExtensionContainer value) Sets the value of the field extensionContainer.
MAPRemoteUserFreeArg	setImsi(IMSIAddress value) Sets the value of the field imsi.
void	setReadOnly() Sets this and all its fields to be immutable.
MAPRemoteUserFreeArg	setReplaceB_NumberPresent(boolean flag) Sets the presence or absence of the optional field replaceB-Number.
MAPRemoteUserFreeArg	setTranslatedB_Number(AddressString value) Sets the value of the field translatedB-Number.

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

MAPRemoteUserFreeArg

public MAPRemoteUserFreeArg()

Constructs an object with uninitialised state.

Method Detail

clone

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

MAPRemoteUserFreeArg

getAlertingPattern

public byte[] getAlertingPattern()

Gets the value of the field alertingPattern.

Returns:

value of field alertingPattern, or null if not present

getCallInfo

public MAPExternalSignalInfo getCallInfo()

Gets the value of the field callInfo.

Returns:

value of field callInfo, or null if not present

getCcbs_Feature

public MAPCCBS_Feature getCcbs_Feature()

Gets the value of the field ccbs-Feature.

Returns:

value of field ccbs-Feature, or null if not present

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

getImsi

public IMSIAddress getImsi()

Gets the value of the field imsi.

Returns:

value of field imsi, or null if not present

getTranslatedB_Number

public AddressString getTranslatedB_Number()

Gets the value of the field translatedB-Number.

Returns:

value of field translatedB-Number, or null if not present

hasAlertingPattern

public boolean hasAlertingPattern()

Tests whether the field alertingPattern has a value.

Returns:

whether the field alertingPattern has a value

hasCallInfo

public boolean hasCallInfo()

Tests whether the field callInfo has a value.

Returns:

whether the field callInfo has a value

hasCcbs_Feature

public boolean hasCcbs_Feature()

Tests whether the field ccbs-Feature has a value.

Returns:

whether the field ccbs-Feature has a value

hasExtensionContainer

public boolean hasExtensionContainer()

Tests whether the field extensionContainer has a value.

Returns:

whether the field extensionContainer has a value

hasImsi

public boolean hasImsi()

Tests whether the field imsi has a value.

Returns:

whether the field imsi has a value

hasReplaceB_Number

public boolean hasReplaceB_Number()

Tests whether the field replaceB-Number is present.

Returns:

whether the field replaceB-Number is present

hasTranslatedB_Number

public boolean hasTranslatedB_Number()

Tests whether the field translatedB-Number has a value.

Returns:

whether the field translatedB-Number has a value

setAlertingPattern

public MAPRemoteUserFreeArg setAlertingPattern(byte[] value)
                                        throws IllegalStateException

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

setCallInfo

public MAPRemoteUserFreeArg setCallInfo(MAPExternalSignalInfo value)
                                 throws IllegalStateException

Sets the value of the field callInfo.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCcbs_Feature

public MAPRemoteUserFreeArg setCcbs_Feature(MAPCCBS_Feature value)
                                     throws IllegalStateException

Sets the value of the field ccbs-Feature.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setExtensionContainer

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

setImsi

public MAPRemoteUserFreeArg setImsi(IMSIAddress value)
                             throws IllegalStateException

Sets the value of the field imsi.

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

setReplaceB_NumberPresent

public MAPRemoteUserFreeArg setReplaceB_NumberPresent(boolean flag)
                                               throws IllegalStateException

Sets the presence or absence of the optional field replaceB-Number.

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

setTranslatedB_Number

public MAPRemoteUserFreeArg setTranslatedB_Number(AddressString value)
                                           throws IllegalStateException

Sets the value of the field translatedB-Number.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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