com.opencloud.slee.resources.cgin.cap_v4

Class CAP4EventSpecificInformationBCSM.TCalledPartyBusySpecificInfo

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CCEventSpecificInformationBCSM.TCalledPartyBusySpecificInfo

CAP2EventSpecificInformationBCSM.TCalledPartyBusySpecificInfo

CAP3EventSpecificInformationBCSM.TCalledPartyBusySpecificInfo

CAP4EventSpecificInformationBCSM.TCalledPartyBusySpecificInfo

All Implemented Interfaces:

DataObject, Serializable

Enclosing class:

CAP4EventSpecificInformationBCSM

public static class CAP4EventSpecificInformationBCSM.TCalledPartyBusySpecificInfo
extends CAP3EventSpecificInformationBCSM.TCalledPartyBusySpecificInfo

API for CAP-datatypes.EventSpecificInformationBCSM.tBusySpecificInfo. Generated from the following ASN.1 type definition and the adaptations below.

 tBusySpecificInfo ::=
     SEQUENCE {
         busyCause                   Cause OPTIONAL,
         callForwarded               NULL OPTIONAL,
         routeNotPermitted           NULL OPTIONAL,
         forwardingDestinationNumber CalledPartyNumber OPTIONAL,
         ...
     }
 CAP-datatypes {
     EventSpecificInformationBCSM {
         tBusySpecificInfo {
             @rename tCalledPartyBusySpecificInfo
         }
     }
 }
 

Used as field type by CAP4EventSpecificInformationBCSM.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CAP4EventSpecificInformationBCSM.TCalledPartyBusySpecificInfo	clone() Constructs a copy of this object and everything reachable from it.
static CAP4EventSpecificInformationBCSM.TCalledPartyBusySpecificInfo	copyOf(CCEventSpecificInformationBCSM.TCalledPartyBusySpecificInfo 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.
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.
CalledPartyNumber	getForwardingDestinationNumber() Gets the value of the field forwardingDestinationNumber.
boolean	hasForwardingDestinationNumber() Tests whether the field forwardingDestinationNumber has a value.
CAP4EventSpecificInformationBCSM.TCalledPartyBusySpecificInfo	setBusyCause(Cause value) Sets the value of the field busyCause.
CAP4EventSpecificInformationBCSM.TCalledPartyBusySpecificInfo	setCallForwardedPresent(boolean flag) Sets the presence or absence of the optional field callForwarded.
CAP4EventSpecificInformationBCSM.TCalledPartyBusySpecificInfo	setForwardingDestinationNumber(CalledPartyNumber value) Sets the value of the field forwardingDestinationNumber.
void	setReadOnly() Sets this and all its fields to be immutable.
CAP4EventSpecificInformationBCSM.TCalledPartyBusySpecificInfo	setRouteNotPermittedPresent(boolean flag) Sets the presence or absence of the optional field routeNotPermitted.

Methods inherited from class CAP3EventSpecificInformationBCSM.TCalledPartyBusySpecificInfo

hasRouteNotPermitted

Methods inherited from class CAP2EventSpecificInformationBCSM.TCalledPartyBusySpecificInfo

hasCallForwarded

Methods inherited from class CCEventSpecificInformationBCSM.TCalledPartyBusySpecificInfo

getBusyCause, hasBusyCause

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

CAP4EventSpecificInformationBCSM.TCalledPartyBusySpecificInfo

public CAP4EventSpecificInformationBCSM.TCalledPartyBusySpecificInfo()

Constructs an object with uninitialised state.

Method Detail

clone

public CAP4EventSpecificInformationBCSM.TCalledPartyBusySpecificInfo clone()

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

Specified by:

clone in interface DataObject

Overrides:

clone in class CAP3EventSpecificInformationBCSM.TCalledPartyBusySpecificInfo

Returns:

copy of object

copyOf

public static CAP4EventSpecificInformationBCSM.TCalledPartyBusySpecificInfo copyOf(CCEventSpecificInformationBCSM.TCalledPartyBusySpecificInfo 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:

CAP4EventSpecificInformationBCSM.TCalledPartyBusySpecificInfo

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 CAP3EventSpecificInformationBCSM.TCalledPartyBusySpecificInfo

Parameters:

withAbsents - whether to put absent optional fields into Map

Returns:

Map from field-name to field-value

getForwardingDestinationNumber

public CalledPartyNumber getForwardingDestinationNumber()

Gets the value of the field forwardingDestinationNumber.

Returns:

value of field forwardingDestinationNumber, or null if not present

hasForwardingDestinationNumber

public boolean hasForwardingDestinationNumber()

Tests whether the field forwardingDestinationNumber has a value.

Returns:

whether the field forwardingDestinationNumber has a value

setBusyCause

public CAP4EventSpecificInformationBCSM.TCalledPartyBusySpecificInfo setBusyCause(Cause value)
                                                                           throws IllegalStateException

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

Overrides:

setBusyCause in class CAP3EventSpecificInformationBCSM.TCalledPartyBusySpecificInfo

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setCallForwardedPresent

public CAP4EventSpecificInformationBCSM.TCalledPartyBusySpecificInfo setCallForwardedPresent(boolean flag)
                                                                                      throws IllegalStateException

Sets the presence or absence of the optional field callForwarded.

Overrides:

setCallForwardedPresent in class CAP3EventSpecificInformationBCSM.TCalledPartyBusySpecificInfo

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

setForwardingDestinationNumber

public CAP4EventSpecificInformationBCSM.TCalledPartyBusySpecificInfo setForwardingDestinationNumber(CalledPartyNumber value)
                                                                                             throws IllegalStateException

Sets the value of the field forwardingDestinationNumber. 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 CCEventSpecificInformationBCSM.TCalledPartyBusySpecificInfo

setRouteNotPermittedPresent

public CAP4EventSpecificInformationBCSM.TCalledPartyBusySpecificInfo setRouteNotPermittedPresent(boolean flag)
                                                                                          throws IllegalStateException

Sets the presence or absence of the optional field routeNotPermitted.

Overrides:

setRouteNotPermittedPresent in class CAP3EventSpecificInformationBCSM.TCalledPartyBusySpecificInfo

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