com.opencloud.slee.resources.cgin.cap_v4

Class CAP4CallSegmentToCancel

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CAP4CallSegmentToCancel

All Implemented Interfaces:

DataObject, Serializable

public class CAP4CallSegmentToCancel
extends AbstractFieldsObject

API for CAP-datatypes.CallSegmentToCancel. Generated from the following ASN.1 type definition.

 CallSegmentToCancel ::=
     SEQUENCE {
         invokeID      InvokeID OPTIONAL,
         callSegmentID CallSegmentID OPTIONAL,
         ...
     }
 

Used as field type by CAP4CancelArg.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CAP4CallSegmentToCancel	clone() Constructs a copy of this object and everything reachable from it.
static CAP4CallSegmentToCancel	copyOf(CAP4CallSegmentToCancel 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.
int	getCallSegmentID() Gets the value of the field callSegmentID.
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.
int	getInvokeID() Gets the value of the field invokeID.
boolean	hasCallSegmentID() Tests whether the field callSegmentID has a value.
boolean	hasInvokeID() Tests whether the field invokeID has a value.
CAP4CallSegmentToCancel	setCallSegmentID(int value) Sets the value of the field callSegmentID and marks the field as present.
CAP4CallSegmentToCancel	setCallSegmentIDPresent(boolean flag) Sets the presence or absence of the optional field callSegmentID.
CAP4CallSegmentToCancel	setInvokeID(int value) Sets the value of the field invokeID and marks the field as present.
CAP4CallSegmentToCancel	setInvokeIDPresent(boolean flag) Sets the presence or absence of the optional field invokeID.

Methods inherited from class com.opencloud.util.AbstractFieldsObject

equals, hashCode, toString

Methods inherited from class com.opencloud.util.AbstractDataObject

checkModify, isReadOnly, setReadOnly

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CAP4CallSegmentToCancel

public CAP4CallSegmentToCancel()

Constructs an object with uninitialised state.

Method Detail

clone

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

CAP4CallSegmentToCancel

getCallSegmentID

public int getCallSegmentID()

Gets the value of the field callSegmentID.

Returns:

value of field callSegmentID

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

getInvokeID

public int getInvokeID()

Gets the value of the field invokeID.

Returns:

value of field invokeID

hasCallSegmentID

public boolean hasCallSegmentID()

Tests whether the field callSegmentID has a value.

Returns:

whether the field callSegmentID has a value

hasInvokeID

public boolean hasInvokeID()

Tests whether the field invokeID has a value.

Returns:

whether the field invokeID has a value

setCallSegmentID

public CAP4CallSegmentToCancel setCallSegmentID(int value)
                                         throws IllegalStateException

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

setCallSegmentIDPresent

public CAP4CallSegmentToCancel setCallSegmentIDPresent(boolean flag)
                                                throws IllegalStateException

Sets the presence or absence of the optional field callSegmentID.

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

setInvokeID

public CAP4CallSegmentToCancel setInvokeID(int value)
                                    throws IllegalStateException

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

setInvokeIDPresent

public CAP4CallSegmentToCancel setInvokeIDPresent(boolean flag)
                                           throws IllegalStateException

Sets the presence or absence of the optional field invokeID.

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