Package com.opencloud.slee.resources.cgin.cap_v4

Class CAP4CancelArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CCCancelArg

CAP4CancelArg

All Implemented Interfaces:

DataObject, Serializable

public class CAP4CancelArg
extends CCCancelArg

API for CAP-gsmSSF-gsmSCF-ops-args.CancelArg. Generated from the following ASN.1 type definition and the adaptations below.

 CancelArg ::=
     CHOICE {
         invokeID            InvokeID,
         allRequests         NULL,
         callSegmentToCancel CallSegmentToCancel
     }
 CAP-gsmSSF-gsmSCF-ops-args {
     CancelArg {
         @parentType com.opencloud.slee.resources.cgin.callcontrol.CCCancelArg
     }
 }
 

Used as argument type by CAP4Operations.cancel.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CAP4CancelArg.Choice	API for CAP-gsmSSF-gsmSCF-ops-args.CancelArg.Choice.

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

Constructor	Description
CAP4CancelArg()

Method Summary

Modifier and Type	Method	Description
CAP4CancelArg	clone()	Constructs a copy of this object and everything reachable from it.
static CAP4CancelArg	copyOf(CCCancelArg 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.
CAP4CallSegmentToCancel	getCallSegmentToCancel()	Gets the value of the callSegmentToCancel choice.
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 :discriminant-name to associated-value.
boolean	isCallSegmentToCancelChosen()	Tests whether the choice is callSegmentToCancel.
CAP4CancelArg	setAllRequests()	Sets the allRequests choice.
CAP4CancelArg	setCallSegmentToCancel(CAP4CallSegmentToCancel value)	Sets the value of the callSegmentToCancel choice.
CAP4CancelArg	setInvokeID(int value)	Sets the value of the invokeID choice.
void	setReadOnly()	Sets this and all its fields to be immutable.

Methods inherited from class com.opencloud.slee.resources.cgin.callcontrol.CCCancelArg

getChoice, getInvokeID, isAllRequestsChosen, isInvokeIDChosen, setChoice

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

CAP4CancelArg

public CAP4CancelArg()

Method Detail

clone

public CAP4CancelArg clone()

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

Specified by:

clone in interface DataObject

Overrides:

clone in class CCCancelArg

Returns:

copy of object

copyOf

public static CAP4CancelArg copyOf(CCCancelArg 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:

CAP4CancelArg

getCallSegmentToCancel

public CAP4CallSegmentToCancel getCallSegmentToCancel()

Gets the value of the callSegmentToCancel choice.

Returns:

value of the choice, if choice is callSegmentToCancel, else null

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 :discriminant-name to associated-value. For a value of primitive type, the value is boxed. If choice is not set, returns a map from : to AbstractFieldsObject.FIELD_UNINITIALISED.

Overrides:

getFieldsMap in class CCCancelArg

Parameters:

withAbsents - ignored, as value cannot be optional

Returns:

Map from :discriminant-name to associated-value

isCallSegmentToCancelChosen

public boolean isCallSegmentToCancelChosen()

Tests whether the choice is callSegmentToCancel.

Returns:

true if chosen, false if not

setAllRequests

public CAP4CancelArg setAllRequests()
                             throws IllegalStateException

Sets the allRequests choice.

Overrides:

setAllRequests in class CCCancelArg

Returns:

this

Throws:

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

setCallSegmentToCancel

public CAP4CancelArg setCallSegmentToCancel(CAP4CallSegmentToCancel value)
                                     throws IllegalStateException,
                                            NullPointerException

Sets the value of the callSegmentToCancel choice.

Parameters:

value - the new value for the choice

Returns:

this

Throws:

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

NullPointerException - if the given value is null

setInvokeID

public CAP4CancelArg setInvokeID(int value)
                          throws IllegalStateException

Sets the value of the invokeID choice.

Overrides:

setInvokeID in class CCCancelArg

Parameters:

value - the new value for the choice

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