com.opencloud.slee.resources.cgin.callcontrol

Class CCInitialDPArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CCInitialDPArg

All Implemented Interfaces:

DataObject, Serializable

Direct Known Subclasses:

CAP1InitialDPArg, CS1InitialDPArg

public class CCInitialDPArg
extends AbstractFieldsObject

API for CC-DataTypes.InitialDPArg. Generated from the following ASN.1 type definition.

 InitialDPArg ::=
     SEQUENCE {
         serviceKey                   ServiceKey,
         calledPartyNumber            CalledPartyNumber OPTIONAL,
         callingPartyNumber           CallingPartyNumber OPTIONAL,
         callingPartysCategory        CallingPartysCategory OPTIONAL,
         iPSSPCapabilities            IPSSPCapabilities OPTIONAL,
         locationNumber               LocationNumber OPTIONAL,
         originalCalledPartyID        OriginalCalledPartyID OPTIONAL,
         highLayerCompatibility       HighLayerCompatibility OPTIONAL,
         additionalCallingPartyNumber AdditionalCallingPartyNumber OPTIONAL,
         bearerCapability             BearerCapability OPTIONAL,
         eventTypeBCSM                EventTypeBCSM OPTIONAL,
         redirectingPartyID           RedirectingPartyID OPTIONAL,
         redirectionInformation       RedirectionInformation OPTIONAL
     }
 

Used as argument type by CCOperations.initialDP.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CCInitialDPArg	clone() Constructs a copy of this object and everything reachable from it.
static CCInitialDPArg	copyOf(CCInitialDPArg 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.
GenericNumber	getAdditionalCallingPartyNumber() Gets the value of the field additionalCallingPartyNumber.
CCBearerCapability	getBearerCapability() Gets the value of the field bearerCapability.
CalledPartyNumber	getCalledPartyNumber() Gets the value of the field calledPartyNumber.
CallingPartyNumber	getCallingPartyNumber() Gets the value of the field callingPartyNumber.
CallingPartysCategory	getCallingPartysCategory() Gets the value of the field callingPartysCategory.
CCEventTypeBCSM	getEventTypeBCSM() Gets the value of the field eventTypeBCSM.
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.
HighLayerCompatibility	getHighLayerCompatibility() Gets the value of the field highLayerCompatibility.
CCIPSSPCapabilities	getIPSSPCapabilities() Gets the value of the field iPSSPCapabilities.
LocationNumber	getLocationNumber() Gets the value of the field locationNumber.
OriginalCalledNumber	getOriginalCalledPartyID() Gets the value of the field originalCalledPartyID.
RedirectingPartyNumber	getRedirectingPartyID() Gets the value of the field redirectingPartyID.
RedirectionInformation	getRedirectionInformation() Gets the value of the field redirectionInformation.
int	getServiceKey() Gets the value of the field serviceKey.
boolean	hasAdditionalCallingPartyNumber() Tests whether the field additionalCallingPartyNumber has a value.
boolean	hasBearerCapability() Tests whether the field bearerCapability has a value.
boolean	hasCalledPartyNumber() Tests whether the field calledPartyNumber has a value.
boolean	hasCallingPartyNumber() Tests whether the field callingPartyNumber has a value.
boolean	hasCallingPartysCategory() Tests whether the field callingPartysCategory has a value.
boolean	hasEventTypeBCSM() Tests whether the field eventTypeBCSM has a value.
boolean	hasHighLayerCompatibility() Tests whether the field highLayerCompatibility has a value.
boolean	hasIPSSPCapabilities() Tests whether the field iPSSPCapabilities has a value.
boolean	hasLocationNumber() Tests whether the field locationNumber has a value.
boolean	hasOriginalCalledPartyID() Tests whether the field originalCalledPartyID has a value.
boolean	hasRedirectingPartyID() Tests whether the field redirectingPartyID has a value.
boolean	hasRedirectionInformation() Tests whether the field redirectionInformation has a value.
boolean	hasServiceKey() Tests whether the field serviceKey has a value.
CCInitialDPArg	setAdditionalCallingPartyNumber(GenericNumber value) Sets the value of the field additionalCallingPartyNumber.
CCInitialDPArg	setBearerCapability(CCBearerCapability value) Sets the value of the field bearerCapability.
CCInitialDPArg	setCalledPartyNumber(CalledPartyNumber value) Sets the value of the field calledPartyNumber.
CCInitialDPArg	setCallingPartyNumber(CallingPartyNumber value) Sets the value of the field callingPartyNumber.
CCInitialDPArg	setCallingPartysCategory(CallingPartysCategory value) Sets the value of the field callingPartysCategory.
CCInitialDPArg	setEventTypeBCSM(CCEventTypeBCSM value) Sets the value of the field eventTypeBCSM.
CCInitialDPArg	setHighLayerCompatibility(HighLayerCompatibility value) Sets the value of the field highLayerCompatibility.
CCInitialDPArg	setIPSSPCapabilities(CCIPSSPCapabilities value) Sets the value of the field iPSSPCapabilities.
CCInitialDPArg	setLocationNumber(LocationNumber value) Sets the value of the field locationNumber.
CCInitialDPArg	setOriginalCalledPartyID(OriginalCalledNumber value) Sets the value of the field originalCalledPartyID.
void	setReadOnly() Sets this and all its fields to be immutable.
CCInitialDPArg	setRedirectingPartyID(RedirectingPartyNumber value) Sets the value of the field redirectingPartyID.
CCInitialDPArg	setRedirectionInformation(RedirectionInformation value) Sets the value of the field redirectionInformation.
CCInitialDPArg	setServiceKey(int value) Sets the value of the field serviceKey and marks the field as present.

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

CCInitialDPArg

public CCInitialDPArg()

Constructs an object with uninitialised state.

Method Detail

clone

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

CCInitialDPArg

getAdditionalCallingPartyNumber

public GenericNumber getAdditionalCallingPartyNumber()

Gets the value of the field additionalCallingPartyNumber.

Returns:

value of field additionalCallingPartyNumber, or null if not present

getBearerCapability

public CCBearerCapability getBearerCapability()

Gets the value of the field bearerCapability.

Returns:

value of field bearerCapability, or null if not present

getCalledPartyNumber

public CalledPartyNumber getCalledPartyNumber()

Gets the value of the field calledPartyNumber.

Returns:

value of field calledPartyNumber, or null if not present

getCallingPartyNumber

public CallingPartyNumber getCallingPartyNumber()

Gets the value of the field callingPartyNumber.

Returns:

value of field callingPartyNumber, or null if not present

getCallingPartysCategory

public CallingPartysCategory getCallingPartysCategory()

Gets the value of the field callingPartysCategory.

Returns:

value of field callingPartysCategory, or null if not present

getEventTypeBCSM

public CCEventTypeBCSM getEventTypeBCSM()

Gets the value of the field eventTypeBCSM.

Returns:

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

getHighLayerCompatibility

public HighLayerCompatibility getHighLayerCompatibility()

Gets the value of the field highLayerCompatibility.

Returns:

value of field highLayerCompatibility, or null if not present

getIPSSPCapabilities

public CCIPSSPCapabilities getIPSSPCapabilities()

Gets the value of the field iPSSPCapabilities.

Returns:

value of field iPSSPCapabilities, or null if not present

getLocationNumber

public LocationNumber getLocationNumber()

Gets the value of the field locationNumber.

Returns:

value of field locationNumber, or null if not present

getOriginalCalledPartyID

public OriginalCalledNumber getOriginalCalledPartyID()

Gets the value of the field originalCalledPartyID.

Returns:

value of field originalCalledPartyID, or null if not present

getRedirectingPartyID

public RedirectingPartyNumber getRedirectingPartyID()

Gets the value of the field redirectingPartyID.

Returns:

value of field redirectingPartyID, or null if not present

getRedirectionInformation

public RedirectionInformation getRedirectionInformation()

Gets the value of the field redirectionInformation.

Returns:

value of field redirectionInformation, or null if not present

getServiceKey

public int getServiceKey()

Gets the value of the field serviceKey.

Returns:

value of field serviceKey

hasAdditionalCallingPartyNumber

public boolean hasAdditionalCallingPartyNumber()

Tests whether the field additionalCallingPartyNumber has a value.

Returns:

whether the field additionalCallingPartyNumber has a value

hasBearerCapability

public boolean hasBearerCapability()

Tests whether the field bearerCapability has a value.

Returns:

whether the field bearerCapability has a value

hasCalledPartyNumber

public boolean hasCalledPartyNumber()

Tests whether the field calledPartyNumber has a value.

Returns:

whether the field calledPartyNumber has a value

hasCallingPartyNumber

public boolean hasCallingPartyNumber()

Tests whether the field callingPartyNumber has a value.

Returns:

whether the field callingPartyNumber has a value

hasCallingPartysCategory

public boolean hasCallingPartysCategory()

Tests whether the field callingPartysCategory has a value.

Returns:

whether the field callingPartysCategory has a value

hasEventTypeBCSM

public boolean hasEventTypeBCSM()

Tests whether the field eventTypeBCSM has a value.

Returns:

whether the field eventTypeBCSM has a value

hasHighLayerCompatibility

public boolean hasHighLayerCompatibility()

Tests whether the field highLayerCompatibility has a value.

Returns:

whether the field highLayerCompatibility has a value

hasIPSSPCapabilities

public boolean hasIPSSPCapabilities()

Tests whether the field iPSSPCapabilities has a value.

Returns:

whether the field iPSSPCapabilities has a value

hasLocationNumber

public boolean hasLocationNumber()

Tests whether the field locationNumber has a value.

Returns:

whether the field locationNumber has a value

hasOriginalCalledPartyID

public boolean hasOriginalCalledPartyID()

Tests whether the field originalCalledPartyID has a value.

Returns:

whether the field originalCalledPartyID has a value

hasRedirectingPartyID

public boolean hasRedirectingPartyID()

Tests whether the field redirectingPartyID has a value.

Returns:

whether the field redirectingPartyID has a value

hasRedirectionInformation

public boolean hasRedirectionInformation()

Tests whether the field redirectionInformation has a value.

Returns:

whether the field redirectionInformation has a value

hasServiceKey

public boolean hasServiceKey()

Tests whether the field serviceKey has a value.

Returns:

whether the field serviceKey has a value

setAdditionalCallingPartyNumber

public CCInitialDPArg setAdditionalCallingPartyNumber(GenericNumber value)
                                               throws IllegalStateException

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

setBearerCapability

public CCInitialDPArg setBearerCapability(CCBearerCapability value)
                                   throws IllegalStateException

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

setCalledPartyNumber

public CCInitialDPArg setCalledPartyNumber(CalledPartyNumber value)
                                    throws IllegalStateException

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

setCallingPartyNumber

public CCInitialDPArg setCallingPartyNumber(CallingPartyNumber value)
                                     throws IllegalStateException

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

setCallingPartysCategory

public CCInitialDPArg setCallingPartysCategory(CallingPartysCategory value)
                                        throws IllegalStateException

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

setEventTypeBCSM

public CCInitialDPArg setEventTypeBCSM(CCEventTypeBCSM value)
                                throws IllegalStateException

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

setHighLayerCompatibility

public CCInitialDPArg setHighLayerCompatibility(HighLayerCompatibility value)
                                         throws IllegalStateException

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

setIPSSPCapabilities

public CCInitialDPArg setIPSSPCapabilities(CCIPSSPCapabilities value)
                                    throws IllegalStateException

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

setLocationNumber

public CCInitialDPArg setLocationNumber(LocationNumber value)
                                 throws IllegalStateException

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

setOriginalCalledPartyID

public CCInitialDPArg setOriginalCalledPartyID(OriginalCalledNumber value)
                                        throws IllegalStateException

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

setRedirectingPartyID

public CCInitialDPArg setRedirectingPartyID(RedirectingPartyNumber value)
                                     throws IllegalStateException

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

setRedirectionInformation

public CCInitialDPArg setRedirectionInformation(RedirectionInformation value)
                                         throws IllegalStateException

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

setServiceKey

public CCInitialDPArg setServiceKey(int value)
                             throws IllegalStateException

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