com.ibm.tivoli.maximo.map.mapman.app

Interface MapManagerRemote

All Superinterfaces:

MboRemote, java.rmi.Remote

All Known Implementing Classes:

MapManager

public interface MapManagerRemote
extends MboRemote

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ARCGIS_FREE_MAPS_INTERNAL_VALUE
static java.lang.String	BING_MAPS_INTERNAL_VALUE
static java.lang.String	GOOGLE_MAPS_AUTHORIZATION_METHOD_APIKEY
static java.lang.String	GOOGLE_MAPS_AUTHORIZATION_METHOD_CLIENTID
static java.lang.String	GOOGLE_MAPS_MAPS_INTERNAL_VALUE
static java.lang.String	OPEN_MAPS_MAPS_INTERNAL_VALUE
static java.lang.String	OPEN_STREET_MAPS_INTERNAL_VALUE
static java.lang.String	SPATIAL_MAPS_INTERNAL_VALUE

Method Summary

Modifier and Type	Method and Description
MapConfiguration	generateAndUpdateMapConfigurationObject() Generates both XML and JSON map configuration definitions files for the current map manager record.
MapConfiguration	generateMapConfigurationObject() Generates both XML and JSON map configuration definitions files for the current map manager record.
java.lang.String	getDistanceMatrixURL() Returns the Google Maps Distance Matrix URL
java.lang.String	getGMapsApiKey() Returns the Google Maps API-KEY
java.lang.String	getGMapsAuthenticationMethod() Returns the Google Maps authorization method.
java.lang.String	getGMapsLicense() Returns the Google Maps license key (client id)
java.lang.String	getGMapsSignature() Returns the Google Maps cryptographic key (api key)
java.lang.String	getMapProvider() Returns the provider associated to this map manager object.
MapTipSetRemote	getMapTipMboSet()
java.lang.String	getOpenMapProvider() Returns the openmap provider associated to this map manager object.
java.lang.String	getOpenMapURL() Returns the OpenStreetMap URL associated to this map manager object.
boolean	isAttributeModified(java.lang.String attributeName) Returns isModified() flag for a given attribute
java.lang.Boolean	isCarbonMap() Returns the boolean depending on the carbon map flag.
java.util.Map	retrieveCommonSymbologyConfig()
MapConfiguration	retrieveMapConfigurationObject(UserInfo userInfo) Gets map configuration JSON definitions and adds initial extent definitions based on the the userInfo.
MapConfiguration	retrieveMapConfigurationObject(UserInfo userInfo, boolean useCache) Gets map configuration JSON definitions and adds initial extent definitions based on the the userInfo.
java.util.Map	retrieveMboClusterConfiguration()
java.util.Map	retrieveMboConfiguration(java.lang.String attribute)
java.util.Map	retrieveMboVisibilityConfiguration()
java.util.Map	retrieveParsedSymbologyConfig()
java.util.Map	retrieveSymbologyForMaximoObject(MboRemote maximoObjectMbo)
java.util.Map	retrieveSymbologyForMaximoObject(java.lang.String mboName)
void	updateMapConfigurationObject(MapConfiguration mapConfiguration) Saves map configuration definitions on the current map manager record.

Methods inherited from interface psdi.mbo.MboRemote

add, addMboSetForRequiredCheck, addToDeleteForInsertList, blindCopy, checkMethodAccess, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, delete, duplicate, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, excludeObjectForPropagate, generateAutoKey, getBoolean, getByte, getBytes, getCommLogOwnerNameAndUniqueId, getDatabaseValue, getDate, getDeleteForInsertList, getDocLinksCount, getDomainIDs, getDouble, getExistingMboSet, getFlags, getFloat, getIgnoreLockCheck, getInitialValue, getInsertCompanySetId, getInsertItemSetId, getInsertOrganization, getInsertSite, getInt, getKeyValue, getLinesRelationship, getList, getLockedByDisplayName, getLong, getMatchingAttr, getMatchingAttr, getMatchingAttrs, getMaxMessage, getMboData, getMboDataSet, getMboInitialValue, getMboList, getMboSet, getMboSet, getMboSet, getMboValueData, getMboValueData, getMboValueData, getMboValueDataForDownload, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getPropagateKeyFlag, getRecordIdentifer, getSiteOrg, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getThisMboSet, getUniqueIDName, getUniqueIDValue, getUserInfo, getUserName, hasHierarchyLink, hasLockSaveRights, isAutoKeyed, isBasedOn, isFlagSet, isForDM, isLocked, isLocked, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNull, isOptionGranted, isSelected, isZombie, lock, propagateKeyValue, rollbackToCheckpoint, select, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDeleted, setESigFieldModified, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlags, setFlag, setFlag, setFlags, setForDM, setIgnoreRecordLockCheck, setMLValue, setModified, setNewMbo, setPropagateKeyFlag, setPropagateKeyFlag, setReferencedMbo, setReferencedMbo, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueNull, setValueNull, sigopGranted, sigopGranted, sigopGranted, sigOptionAccessAuthorized, smartFill, smartFind, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, unlock, unselect, validate, validateAttributes

Field Detail

GOOGLE_MAPS_AUTHORIZATION_METHOD_APIKEY

static final java.lang.String GOOGLE_MAPS_AUTHORIZATION_METHOD_APIKEY

See Also:

Constant Field Values

GOOGLE_MAPS_AUTHORIZATION_METHOD_CLIENTID

static final java.lang.String GOOGLE_MAPS_AUTHORIZATION_METHOD_CLIENTID

See Also:

Constant Field Values

BING_MAPS_INTERNAL_VALUE

static final java.lang.String BING_MAPS_INTERNAL_VALUE

See Also:

Constant Field Values

SPATIAL_MAPS_INTERNAL_VALUE

static final java.lang.String SPATIAL_MAPS_INTERNAL_VALUE

See Also:

Constant Field Values

GOOGLE_MAPS_MAPS_INTERNAL_VALUE

static final java.lang.String GOOGLE_MAPS_MAPS_INTERNAL_VALUE

See Also:

Constant Field Values

OPEN_MAPS_MAPS_INTERNAL_VALUE

static final java.lang.String OPEN_MAPS_MAPS_INTERNAL_VALUE

See Also:

Constant Field Values

ARCGIS_FREE_MAPS_INTERNAL_VALUE

static final java.lang.String ARCGIS_FREE_MAPS_INTERNAL_VALUE

See Also:

Constant Field Values

OPEN_STREET_MAPS_INTERNAL_VALUE

static final java.lang.String OPEN_STREET_MAPS_INTERNAL_VALUE

See Also:

Constant Field Values

Method Detail

isAttributeModified

boolean isAttributeModified(java.lang.String attributeName)
                     throws MXException,
                            java.rmi.RemoteException

Returns isModified() flag for a given attribute

Throws:

MXException

java.rmi.RemoteException

getGMapsLicense

java.lang.String getGMapsLicense()
                          throws java.rmi.RemoteException,
                                 MXException

Returns the Google Maps license key (client id)

Returns:

String

Throws:

MXException

java.rmi.RemoteException

getGMapsSignature

java.lang.String getGMapsSignature()
                            throws java.rmi.RemoteException,
                                   MXException

Returns the Google Maps cryptographic key (api key)

Returns:

String

Throws:

MXException

java.rmi.RemoteException

getGMapsAuthenticationMethod

java.lang.String getGMapsAuthenticationMethod()
                                       throws java.rmi.RemoteException,
                                              MXException

Returns the Google Maps authorization method.

Returns:

Throws:

java.rmi.RemoteException

MXException

getDistanceMatrixURL

java.lang.String getDistanceMatrixURL()
                               throws java.rmi.RemoteException,
                                      MXException

Returns the Google Maps Distance Matrix URL

Returns:

String

Throws:

MXException

java.rmi.RemoteException

getGMapsApiKey

java.lang.String getGMapsApiKey()
                         throws java.rmi.RemoteException,
                                MXException

Returns the Google Maps API-KEY

Returns:

Throws:

java.rmi.RemoteException

MXException

getMapProvider

java.lang.String getMapProvider()
                         throws java.rmi.RemoteException,
                                MXException

Returns the provider associated to this map manager object.

Parameters:

mapManager -

Returns:

Throws:

java.rmi.RemoteException

MXException

isCarbonMap

java.lang.Boolean isCarbonMap()
                       throws java.rmi.RemoteException,
                              MXException

Returns the boolean depending on the carbon map flag.

Parameters:

mapManager -

Returns:

Throws:

java.rmi.RemoteException

MXException

retrieveSymbologyForMaximoObject

java.util.Map retrieveSymbologyForMaximoObject(MboRemote maximoObjectMbo)
                                        throws MXException,
                                               java.io.IOException

Parameters:

maximoObjectMbo -

Returns:

Throws:

MXException

java.io.IOException

getMapTipMboSet

MapTipSetRemote getMapTipMboSet()
                         throws java.rmi.RemoteException,
                                MXException

Returns:

Throws:

java.rmi.RemoteException

MXException

retrieveSymbologyForMaximoObject

java.util.Map retrieveSymbologyForMaximoObject(java.lang.String mboName)
                                        throws MXException,
                                               java.io.IOException

Parameters:

mboName -

mapManagerMbo -

Returns:

Throws:

java.io.IOException

MXException

retrieveCommonSymbologyConfig

java.util.Map retrieveCommonSymbologyConfig()
                                     throws MXException,
                                            java.io.IOException

Returns:

Throws:

java.io.IOException

MXException

retrieveParsedSymbologyConfig

java.util.Map retrieveParsedSymbologyConfig()
                                     throws MXException,
                                            java.io.IOException

Returns:

Throws:

MXException

java.io.IOException

retrieveMboVisibilityConfiguration

java.util.Map retrieveMboVisibilityConfiguration()
                                          throws MXException,
                                                 java.io.IOException

Returns:

Throws:

java.io.IOException

MXException

retrieveMboClusterConfiguration

java.util.Map retrieveMboClusterConfiguration()
                                       throws MXException,
                                              java.io.IOException

Returns:

Throws:

MXException

java.io.IOException

retrieveMboConfiguration

java.util.Map retrieveMboConfiguration(java.lang.String attribute)
                                throws MXException,
                                       java.io.IOException

Parameters:

attribute -

Returns:

Throws:

MXException

java.io.IOException

retrieveMapConfigurationObject

MapConfiguration retrieveMapConfigurationObject(UserInfo userInfo)
                                         throws MXException,
                                                java.rmi.RemoteException

Gets map configuration JSON definitions and adds initial extent definitions based on the the userInfo.

Parameters:

userInfo -

Throws:

MXException

java.rmi.RemoteException

retrieveMapConfigurationObject

MapConfiguration retrieveMapConfigurationObject(UserInfo userInfo,
                                                boolean useCache)
                                         throws MXException,
                                                java.rmi.RemoteException

Gets map configuration JSON definitions and adds initial extent definitions based on the the userInfo.

Parameters:

userInfo -

useCache - If true, it will use the map configuration from the database. Otherwise, it will generate a map configuration.

Throws:

MXException

java.rmi.RemoteException

generateAndUpdateMapConfigurationObject

MapConfiguration generateAndUpdateMapConfigurationObject()
                                                  throws MXException,
                                                         java.io.IOException

Generates both XML and JSON map configuration definitions files for the current map manager record. And saves the generated map configuration definitions on the current map manager record.

Returns:

generated map configuration definition

Throws:

java.io.IOException

MXException

generateMapConfigurationObject

MapConfiguration generateMapConfigurationObject()
                                         throws MXException,
                                                java.io.IOException

Generates both XML and JSON map configuration definitions files for the current map manager record.

Returns:

generated map configuration definition

Throws:

MXException

java.io.IOException

updateMapConfigurationObject

void updateMapConfigurationObject(MapConfiguration mapConfiguration)
                           throws java.rmi.RemoteException,
                                  MXException

Saves map configuration definitions on the current map manager record.

Parameters:

mapConfiguration -

Throws:

java.rmi.RemoteException

MXException

getOpenMapProvider

java.lang.String getOpenMapProvider()
                             throws java.rmi.RemoteException,
                                    MXException

Returns the openmap provider associated to this map manager object.

Parameters:

mapManager -

Returns:

Throws:

java.rmi.RemoteException

MXException

getOpenMapURL

java.lang.String getOpenMapURL()
                        throws java.rmi.RemoteException,
                               MXException

Returns the OpenStreetMap URL associated to this map manager object.

Returns:

String

Throws:

java.rmi.RemoteException

MXException