Class MQSession

Object
   |
   +--MQObject
         |
         +--MQObjectCollection
               |
               +--MQSession

class MQSession

extends MQObjectCollection

Uniquely identifies a MQSession. Maintains the state of the current user's requests. Contains zero or one of the following objects: MQMapCommand, MQMapState, MQDBLayerQueryCollection, MQFeatureCollection, and MQCoverageStyle.
See:

- MQMapCommand
- MQMapState
- MQDBLayerQueryCollection
- MQFeatureCollection
- MQCoverageStyle
- MQPrimitiveCollection
- MQAutoMapCovSwitch

Constructor Detail

MQSession

MQSession()

See:
- MQMapCommand
- MQMapState
- MQDBLayerQueryCollection
- MQFeatureCollection
- MQCoverageStyle
- MQPrimitiveCollection
- MQAutoMapCovSwitch

add

void add(<MQObject> obj)

Adds a MQObject to the collection. Calls addOne(MQObject, null).

Parameters:
obj - The new MQObject to be added to the collection.

See:
- addOne(MQObject, null)

addOne

void addOne(<MQObject> newElement, <MQObject> replacedElement)

Adds an element to this Session object, ensuring that it is the only one of its class type. Validates element as being one of object types that is permitted in this Session object. If it is, and there happens to be one of that type of object already present, the new object will replace it.

Parameters:
newElement - The new element that is to be added to this MQSession object.
replacedElement - The element that was previously in this MQSession object.

Returns:
index of element that is added.

getClassName

String getClassName()

Returns the text name of this class.

Returns:
The text name of this class.

getObjectVersion

int getObjectVersion()

Returns the version of this class.

Returns:
The version of this class.

isMapCommandObject

Boolean isMapCommandObject(<MQObject> obj)

Returns true if the specified object is a MapCommand object, false otherwise.
MQMapCommand objects
• MQCenter
• MQCenterLatLng
• MQZoomIn
• MQZoomOut
• MQZoomTo
• MQZoomToRect
• MQZoomToRectLatLng
• MQPan
• MQBestFit
• MQBestFitLL

Parameters:
obj - The MQObject to be validated.

Returns:
true if the specified object is a MapComand object, false otherwise.

isValidObject

Boolean isValidObject(<MQObject> obj)

Returns true if the specified object is a valid object for this collection, false otherwise.
Valid objects
• MQCenter
• MQCenterLatLng
• MQZoomIn
• MQZoomOut
• MQZoomTo
• MQZoomToRect
• MQZoomToRectLatLng
• MQPan
• MQBestFit
• MQBestFitLL
• MQDBLayerQueryCollection
• MQCoverageStyle
• MQFeatureCollection
• MQAutoMapCovSwitch
• MQPrimitiveCollection
• MQMapState

Parameters:
obj - The MQObject to be validated.

Returns:
Boolean true if the specified object is a valid object for this collection, false otherwise.

loadXml

void loadXml(<String> strXml)

Assigns the xml that relates to this object.

Parameters:
strXml - the xml to be assigned.

saveXml

String saveXml()

Build an xml string that represents this object.

Returns:
The xml string.