com.opencloud.slee.resources.cgin.map

Class MAPCancelLocationArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

MAPCancelLocation_v1ArgSeq

MAPCancelLocationArg

All Implemented Interfaces:

DataObject, Serializable

public class MAPCancelLocationArg
extends MAPCancelLocation_v1ArgSeq

API for MAP-MS-DataTypes.CancelLocationArg. Generated from the following ASN.1 type definition and the adaptations below.

 CancelLocationArg ::=
     SEQUENCE {
         identity           Identity,
         cancellationType   CancellationType OPTIONAL,   -- Added in R97.
         extensionContainer ExtensionContainer OPTIONAL, -- Added in R97.
         ...
         typeOfUpdate       TypeOfUpdate OPTIONAL        -- Added in release 8.
     }
 MAP-MS-DataTypes {
     CancelLocationArg {
         @parentASN1Type MAP-MobileServiceOperations-R96.cancelLocation.ArgumentType
     }
 }
 

Extended in ph2. TypeOfUpdate shall be absent if CancellationType is different from updateProcedure.

Used as argument type by MAPOperations.cancelLocation_v3.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
MAPCancelLocationArg	clone() Constructs a copy of this object and everything reachable from it.
static MAPCancelLocationArg	copyOf(MAPCancelLocation_v1ArgSeq 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.
MAPCancellationType	getCancellationType() Gets the value of the field cancellationType.
MAPExtensionContainer	getExtensionContainer() Gets the value of the field extensionContainer.
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.
MAPTypeOfUpdate	getTypeOfUpdate() Gets the value of the field typeOfUpdate.
boolean	hasCancellationType() Tests whether the field cancellationType has a value.
boolean	hasExtensionContainer() Tests whether the field extensionContainer has a value.
boolean	hasTypeOfUpdate() Tests whether the field typeOfUpdate has a value.
MAPCancelLocationArg	setCancellationType(MAPCancellationType value) Sets the value of the field cancellationType.
MAPCancelLocationArg	setExtensionContainer(MAPExtensionContainer value) Sets the value of the field extensionContainer.
MAPCancelLocationArg	setIdentity(MAPIdentity value) Sets the value of the field identity.
void	setReadOnly() Sets this and all its fields to be immutable.
MAPCancelLocationArg	setTypeOfUpdate(MAPTypeOfUpdate value) Sets the value of the field typeOfUpdate.

Methods inherited from class MAPCancelLocation_v1ArgSeq

getIdentity, hasIdentity

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

MAPCancelLocationArg

public MAPCancelLocationArg()

Constructs an object with uninitialised state.

Method Detail

clone

public MAPCancelLocationArg clone()

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

Specified by:

clone in interface DataObject

Overrides:

clone in class MAPCancelLocation_v1ArgSeq

Returns:

copy of object

copyOf

public static MAPCancelLocationArg copyOf(MAPCancelLocation_v1ArgSeq 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:

MAPCancelLocationArg

getCancellationType

public MAPCancellationType getCancellationType()

Gets the value of the field cancellationType.

Returns:

value of field cancellationType, or null if not present

getExtensionContainer

public MAPExtensionContainer getExtensionContainer()

Gets the value of the field extensionContainer.

Returns:

value of field extensionContainer, 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 MAPCancelLocation_v1ArgSeq

Parameters:

withAbsents - whether to put absent optional fields into Map

Returns:

Map from field-name to field-value

getTypeOfUpdate

public MAPTypeOfUpdate getTypeOfUpdate()

Gets the value of the field typeOfUpdate.

Returns:

value of field typeOfUpdate, or null if not present

hasCancellationType

public boolean hasCancellationType()

Tests whether the field cancellationType has a value.

Returns:

whether the field cancellationType has a value

hasExtensionContainer

public boolean hasExtensionContainer()

Tests whether the field extensionContainer has a value.

Returns:

whether the field extensionContainer has a value

hasTypeOfUpdate

public boolean hasTypeOfUpdate()

Tests whether the field typeOfUpdate has a value.

Returns:

whether the field typeOfUpdate has a value

setCancellationType

public MAPCancelLocationArg setCancellationType(MAPCancellationType value)
                                         throws IllegalStateException

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

setExtensionContainer

public MAPCancelLocationArg setExtensionContainer(MAPExtensionContainer value)
                                           throws IllegalStateException

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

setIdentity

public MAPCancelLocationArg setIdentity(MAPIdentity value)
                                 throws IllegalStateException

Sets the value of the field identity.

Overrides:

setIdentity in class MAPCancelLocation_v1ArgSeq

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 MAPCancelLocation_v1ArgSeq

setTypeOfUpdate

public MAPCancelLocationArg setTypeOfUpdate(MAPTypeOfUpdate value)
                                     throws IllegalStateException

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