com.opencloud.slee.resources.cgin.etsi_inap_cs1

Class CS1InitialDPArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CCInitialDPArg

CS1InitialDPArg

All Implemented Interfaces:

DataObject, Serializable

public class CS1InitialDPArg
extends CCInitialDPArg

API for Core-INAP-CS1-DataTypes.InitialDPArg. Generated from the following ASN.1 type definition and the adaptations below.

 InitialDPArg ::=
     SEQUENCE {
         serviceKey                   ServiceKey,
         calledPartyNumber            CalledPartyNumber OPTIONAL,
         callingPartyNumber           CallingPartyNumber OPTIONAL,
         callingPartysCategory        CallingPartysCategory OPTIONAL,
         cGEncountered                CGEncountered OPTIONAL,
         iPSSPCapabilities            IPSSPCapabilities OPTIONAL,
         iPAvailable                  IPAvailable OPTIONAL,
         locationNumber               LocationNumber OPTIONAL,
         originalCalledPartyID        OriginalCalledPartyID OPTIONAL,
         extensions                   SEQUENCE (SIZE (1..1000)) OF ExtensionField OPTIONAL,
         highLayerCompatibility       HighLayerCompatibility OPTIONAL,
         serviceInteractionIndicators ServiceInteractionIndicators OPTIONAL,
         additionalCallingPartyNumber AdditionalCallingPartyNumber OPTIONAL,
         forwardCallIndicators        ForwardCallIndicators OPTIONAL,
         bearerCapability             BearerCapability OPTIONAL,
         eventTypeBCSM                EventTypeBCSM OPTIONAL,
         redirectingPartyID           RedirectingPartyID OPTIONAL,
         redirectionInformation       RedirectionInformation OPTIONAL,
         ...
     }
 Core-INAP-CS1-DataTypes {
     InitialDPArg {
         @parentType com.opencloud.slee.resources.cgin.callcontrol.CCInitialDPArg
     }
 }
 

Used as argument type by CS1Operations.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
CS1InitialDPArg() Constructs an object with uninitialised state.

Method Summary

Methods

Modifier and Type	Method and Description
CS1InitialDPArg	clone() Constructs a copy of this object and everything reachable from it.
static CS1InitialDPArg	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.
CS1CGEncountered	getCGEncountered() Gets the value of the field cGEncountered.
CS1ExtensionField[]	getExtensions() Gets the value of the field extensions.
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.
ForwardCallIndicators	getForwardCallIndicators() Gets the value of the field forwardCallIndicators.
CS1IPAvailable	getIPAvailable() Gets the value of the field iPAvailable.
CS1ServiceInteractionIndicators	getServiceInteractionIndicators() Gets the value of the field serviceInteractionIndicators.
boolean	hasCGEncountered() Tests whether the field cGEncountered has a value.
boolean	hasExtensions() Tests whether the field extensions has a value.
boolean	hasForwardCallIndicators() Tests whether the field forwardCallIndicators has a value.
boolean	hasIPAvailable() Tests whether the field iPAvailable has a value.
boolean	hasServiceInteractionIndicators() Tests whether the field serviceInteractionIndicators has a value.
CS1InitialDPArg	setAdditionalCallingPartyNumber(GenericNumber value) Sets the value of the field additionalCallingPartyNumber.
CS1InitialDPArg	setBearerCapability(CCBearerCapability value) Sets the value of the field bearerCapability.
CS1InitialDPArg	setCalledPartyNumber(CalledPartyNumber value) Sets the value of the field calledPartyNumber.
CS1InitialDPArg	setCallingPartyNumber(CallingPartyNumber value) Sets the value of the field callingPartyNumber.
CS1InitialDPArg	setCallingPartysCategory(CallingPartysCategory value) Sets the value of the field callingPartysCategory.
CS1InitialDPArg	setCGEncountered(CS1CGEncountered value) Sets the value of the field cGEncountered.
CS1InitialDPArg	setEventTypeBCSM(CCEventTypeBCSM value) Sets the value of the field eventTypeBCSM.
CS1InitialDPArg	setExtensions(CS1ExtensionField[] value) Sets the value of the field extensions.
CS1InitialDPArg	setForwardCallIndicators(ForwardCallIndicators value) Sets the value of the field forwardCallIndicators.
CS1InitialDPArg	setHighLayerCompatibility(HighLayerCompatibility value) Sets the value of the field highLayerCompatibility.
CS1InitialDPArg	setIPAvailable(CS1IPAvailable value) Sets the value of the field iPAvailable.
CS1InitialDPArg	setIPSSPCapabilities(CCIPSSPCapabilities value) Sets the value of the field iPSSPCapabilities.
CS1InitialDPArg	setLocationNumber(LocationNumber value) Sets the value of the field locationNumber.
CS1InitialDPArg	setOriginalCalledPartyID(OriginalCalledNumber value) Sets the value of the field originalCalledPartyID.
void	setReadOnly() Sets this and all its fields to be immutable.
CS1InitialDPArg	setRedirectingPartyID(RedirectingPartyNumber value) Sets the value of the field redirectingPartyID.
CS1InitialDPArg	setRedirectionInformation(RedirectionInformation value) Sets the value of the field redirectionInformation.
CS1InitialDPArg	setServiceInteractionIndicators(CS1ServiceInteractionIndicators value) Sets the value of the field serviceInteractionIndicators.
CS1InitialDPArg	setServiceKey(int value) Sets the value of the field serviceKey.

Methods inherited from class CCInitialDPArg

getAdditionalCallingPartyNumber, getBearerCapability, getCalledPartyNumber, getCallingPartyNumber, getCallingPartysCategory, getEventTypeBCSM, getHighLayerCompatibility, getIPSSPCapabilities, getLocationNumber, getOriginalCalledPartyID, getRedirectingPartyID, getRedirectionInformation, getServiceKey, hasAdditionalCallingPartyNumber, hasBearerCapability, hasCalledPartyNumber, hasCallingPartyNumber, hasCallingPartysCategory, hasEventTypeBCSM, hasHighLayerCompatibility, hasIPSSPCapabilities, hasLocationNumber, hasOriginalCalledPartyID, hasRedirectingPartyID, hasRedirectionInformation, hasServiceKey

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

CS1InitialDPArg

public CS1InitialDPArg()

Constructs an object with uninitialised state.

Method Detail

clone

public CS1InitialDPArg clone()

Constructs a copy of this object and everything reachable from it.

Specified by:

clone in interface DataObject

Overrides:

clone in class CCInitialDPArg

Returns:

copy of object

copyOf

public static CS1InitialDPArg 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:

CS1InitialDPArg

getCGEncountered

public CS1CGEncountered getCGEncountered()

Gets the value of the field cGEncountered.

Returns:

value of field cGEncountered, or null if not present

getExtensions

public CS1ExtensionField[] getExtensions()

Gets the value of the field extensions.

Returns:

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

Overrides:

getFieldsMap in class CCInitialDPArg

Parameters:

withAbsents - whether to put absent optional fields into Map

Returns:

Map from field-name to field-value

getForwardCallIndicators

public ForwardCallIndicators getForwardCallIndicators()

Gets the value of the field forwardCallIndicators.

Returns:

value of field forwardCallIndicators, or null if not present

getIPAvailable

public CS1IPAvailable getIPAvailable()

Gets the value of the field iPAvailable.

Returns:

value of field iPAvailable, or null if not present

getServiceInteractionIndicators

public CS1ServiceInteractionIndicators getServiceInteractionIndicators()

Gets the value of the field serviceInteractionIndicators.

Returns:

value of field serviceInteractionIndicators, or null if not present

hasCGEncountered

public boolean hasCGEncountered()

Tests whether the field cGEncountered has a value.

Returns:

whether the field cGEncountered has a value

hasExtensions

public boolean hasExtensions()

Tests whether the field extensions has a value.

Returns:

whether the field extensions has a value

hasForwardCallIndicators

public boolean hasForwardCallIndicators()

Tests whether the field forwardCallIndicators has a value.

Returns:

whether the field forwardCallIndicators has a value

hasIPAvailable

public boolean hasIPAvailable()

Tests whether the field iPAvailable has a value.

Returns:

whether the field iPAvailable has a value

hasServiceInteractionIndicators

public boolean hasServiceInteractionIndicators()

Tests whether the field serviceInteractionIndicators has a value.

Returns:

whether the field serviceInteractionIndicators has a value

setAdditionalCallingPartyNumber

public CS1InitialDPArg setAdditionalCallingPartyNumber(GenericNumber value)
                                                throws IllegalStateException

Sets the value of the field additionalCallingPartyNumber. If null, marks the field as absent.

Overrides:

setAdditionalCallingPartyNumber in class CCInitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setBearerCapability

public CS1InitialDPArg setBearerCapability(CCBearerCapability value)
                                    throws IllegalStateException

Sets the value of the field bearerCapability. If null, marks the field as absent.

Overrides:

setBearerCapability in class CCInitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCGEncountered

public CS1InitialDPArg setCGEncountered(CS1CGEncountered value)
                                 throws IllegalStateException

Sets the value of the field cGEncountered. 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 CS1InitialDPArg setCalledPartyNumber(CalledPartyNumber value)
                                     throws IllegalStateException

Sets the value of the field calledPartyNumber. If null, marks the field as absent.

Overrides:

setCalledPartyNumber in class CCInitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCallingPartyNumber

public CS1InitialDPArg setCallingPartyNumber(CallingPartyNumber value)
                                      throws IllegalStateException

Sets the value of the field callingPartyNumber. If null, marks the field as absent.

Overrides:

setCallingPartyNumber in class CCInitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCallingPartysCategory

public CS1InitialDPArg setCallingPartysCategory(CallingPartysCategory value)
                                         throws IllegalStateException

Sets the value of the field callingPartysCategory. If null, marks the field as absent.

Overrides:

setCallingPartysCategory in class CCInitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setEventTypeBCSM

public CS1InitialDPArg setEventTypeBCSM(CCEventTypeBCSM value)
                                 throws IllegalStateException

Sets the value of the field eventTypeBCSM. If null, marks the field as absent.

Overrides:

setEventTypeBCSM in class CCInitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setExtensions

public CS1InitialDPArg setExtensions(CS1ExtensionField[] value)
                              throws IllegalStateException

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

setForwardCallIndicators

public CS1InitialDPArg setForwardCallIndicators(ForwardCallIndicators value)
                                         throws IllegalStateException

Sets the value of the field forwardCallIndicators. 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 CS1InitialDPArg setHighLayerCompatibility(HighLayerCompatibility value)
                                          throws IllegalStateException

Sets the value of the field highLayerCompatibility. If null, marks the field as absent.

Overrides:

setHighLayerCompatibility in class CCInitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setIPAvailable

public CS1InitialDPArg setIPAvailable(CS1IPAvailable value)
                               throws IllegalStateException

Sets the value of the field iPAvailable. 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 CS1InitialDPArg setIPSSPCapabilities(CCIPSSPCapabilities value)
                                     throws IllegalStateException

Sets the value of the field iPSSPCapabilities. If null, marks the field as absent.

Overrides:

setIPSSPCapabilities in class CCInitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setLocationNumber

public CS1InitialDPArg setLocationNumber(LocationNumber value)
                                  throws IllegalStateException

Sets the value of the field locationNumber. If null, marks the field as absent.

Overrides:

setLocationNumber in class CCInitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setOriginalCalledPartyID

public CS1InitialDPArg setOriginalCalledPartyID(OriginalCalledNumber value)
                                         throws IllegalStateException

Sets the value of the field originalCalledPartyID. If null, marks the field as absent.

Overrides:

setOriginalCalledPartyID in class CCInitialDPArg

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 CCInitialDPArg

setRedirectingPartyID

public CS1InitialDPArg setRedirectingPartyID(RedirectingPartyNumber value)
                                      throws IllegalStateException

Sets the value of the field redirectingPartyID. If null, marks the field as absent.

Overrides:

setRedirectingPartyID in class CCInitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setRedirectionInformation

public CS1InitialDPArg setRedirectionInformation(RedirectionInformation value)
                                          throws IllegalStateException

Sets the value of the field redirectionInformation. If null, marks the field as absent.

Overrides:

setRedirectionInformation in class CCInitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setServiceInteractionIndicators

public CS1InitialDPArg setServiceInteractionIndicators(CS1ServiceInteractionIndicators value)
                                                throws IllegalStateException

Sets the value of the field serviceInteractionIndicators. 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 CS1InitialDPArg setServiceKey(int value)
                              throws IllegalStateException

Sets the value of the field serviceKey.

Overrides:

setServiceKey in class CCInitialDPArg

Parameters:

value - the new value for the field

Returns:

this

Throws:

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