com.opencloud.slee.resources.cgin.map

Class MAPMAP_UserAbortChoice

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

MAPMAP_UserAbortChoice

All Implemented Interfaces:

DataObject, Serializable

public class MAPMAP_UserAbortChoice
extends AbstractFieldsObject

API for MAP-DialogueInformation.MAP-UserAbortChoice. Generated from the following ASN.1 type definition.

 MAP-UserAbortChoice ::=
     CHOICE {
         userSpecificReason               NULL,
         userResourceLimitation           NULL,
         resourceUnavailable              ResourceUnavailableReason,
         applicationProcedureCancellation ProcedureCancellationReason
     }
 

Added in ph2. Spelt MAPMAP_UserAbortChoice because it's generated from something in the MAP spec that's called MAP-UserAbortChoice.

Used as field type by MAPMAP_UserAbortInfo.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MAPMAP_UserAbortChoice.Choice API for MAP-DialogueInformation.MAP-UserAbortChoice.Choice.

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

Constructor and Description
MAPMAP_UserAbortChoice()

Method Summary

Methods

Modifier and Type	Method and Description
MAPMAP_UserAbortChoice	clone() Constructs a copy of this object and everything reachable from it.
static MAPMAP_UserAbortChoice	copyOf(MAPMAP_UserAbortChoice 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.
MAPProcedureCancellationReason	getApplicationProcedureCancellation() Gets the value of the applicationProcedureCancellation choice.
MAPMAP_UserAbortChoice.Choice	getChoice() Gets the discriminant of the current 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.
MAPResourceUnavailableReason	getResourceUnavailable() Gets the value of the resourceUnavailable choice.
boolean	isApplicationProcedureCancellationChosen() Tests whether the choice is applicationProcedureCancellation.
boolean	isResourceUnavailableChosen() Tests whether the choice is resourceUnavailable.
boolean	isUserResourceLimitationChosen() Tests whether the choice is userResourceLimitation.
boolean	isUserSpecificReasonChosen() Tests whether the choice is userSpecificReason.
MAPMAP_UserAbortChoice	setApplicationProcedureCancellation(MAPProcedureCancellationReason value) Sets the value of the applicationProcedureCancellation choice.
MAPMAP_UserAbortChoice	setResourceUnavailable(MAPResourceUnavailableReason value) Sets the value of the resourceUnavailable choice.
MAPMAP_UserAbortChoice	setUserResourceLimitation() Sets the userResourceLimitation choice.
MAPMAP_UserAbortChoice	setUserSpecificReason() Sets the userSpecificReason choice.

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

MAPMAP_UserAbortChoice

public MAPMAP_UserAbortChoice()

Method Detail

clone

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

MAPMAP_UserAbortChoice

getApplicationProcedureCancellation

public MAPProcedureCancellationReason getApplicationProcedureCancellation()

Gets the value of the applicationProcedureCancellation choice.

Returns:

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

getChoice

public MAPMAP_UserAbortChoice.Choice getChoice()

Gets the discriminant of the current choice.

Returns:

the current discriminant

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.

Specified by:

getFieldsMap in class AbstractFieldsObject

Parameters:

withAbsents - ignored, as value cannot be optional

Returns:

Map from :discriminant-name to associated-value

getResourceUnavailable

public MAPResourceUnavailableReason getResourceUnavailable()

Gets the value of the resourceUnavailable choice.

Returns:

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

isApplicationProcedureCancellationChosen

public boolean isApplicationProcedureCancellationChosen()

Tests whether the choice is applicationProcedureCancellation.

Returns:

true if chosen, false if not

isResourceUnavailableChosen

public boolean isResourceUnavailableChosen()

Tests whether the choice is resourceUnavailable.

Returns:

true if chosen, false if not

isUserResourceLimitationChosen

public boolean isUserResourceLimitationChosen()

Tests whether the choice is userResourceLimitation.

Returns:

true if chosen, false if not

isUserSpecificReasonChosen

public boolean isUserSpecificReasonChosen()

Tests whether the choice is userSpecificReason.

Returns:

true if chosen, false if not

setApplicationProcedureCancellation

public MAPMAP_UserAbortChoice setApplicationProcedureCancellation(MAPProcedureCancellationReason value)
                                                           throws IllegalStateException,
                                                                  NullPointerException

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

setResourceUnavailable

public MAPMAP_UserAbortChoice setResourceUnavailable(MAPResourceUnavailableReason value)
                                              throws IllegalStateException,
                                                     NullPointerException

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

setUserResourceLimitation

public MAPMAP_UserAbortChoice setUserResourceLimitation()
                                                 throws IllegalStateException

Sets the userResourceLimitation choice.

Returns:

this

Throws:

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

setUserSpecificReason

public MAPMAP_UserAbortChoice setUserSpecificReason()
                                             throws IllegalStateException

Sets the userSpecificReason choice.

Returns:

this

Throws:

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