com.ibm.tivoli.maximo.map.data

Class GpsDataCollectorComponent

java.lang.Object

psdi.webclient.system.controller.BaseInstance

psdi.webclient.system.controller.ComponentInstance

psdi.webclient.system.controller.DynamicAttributeComponent

psdi.webclient.system.controller.BoundComponentInstance

com.ibm.tivoli.maximo.map.data.GpsDataCollectorComponent

All Implemented Interfaces:

java.lang.Cloneable, DataBeanListener

public class GpsDataCollectorComponent
extends BoundComponentInstance

Property Summary

Properties inherited from class psdi.webclient.system.controller.ComponentInstance

hiddenByProperty

Field Summary

Fields inherited from class psdi.webclient.system.controller.BoundComponentInstance

ATTRIBUTE_NAME, BAD_BINDING_CSS, bound, BOUND_LABEL, COLUMN_NAME, CSS_CLASS, DATA_ATTRIBUTE, DEFAULT_LABEL, DOMAIN, ENTITY_NAME, EVENT_PRIORITY, FIELD_LABEL, HAS_LONG_DESCRIPTION, HIDE_LABEL, ID, INT_TYPE, INTERNAL, INVALID_BINDING, IS_NUMERIC, IS_PERSISTENT, KEY, LABEL, LABELFORMAT, LENGTH, LONGDESC_ATTRIBUTE_SUFFIX, OBJECT_NAME, PRIORITY_DATATYPE, PRIORITY_FLUSH, PRIORITY_VALIDATION, QUERY, REMARKS, SCALE, SIZE, SYNCHRONOUS, TAKESVALUE, TITLE, TRUELENGTH, TYPEAHEADATTRS

Fields inherited from class psdi.webclient.system.controller.DynamicAttributeComponent

CLASSSPECVALUEATTRIBUTES, DYNAMICATTRIBUTE

Fields inherited from class psdi.webclient.system.controller.ComponentInstance

CLICKABLE_OFF, CLICKABLE_ON, CONTAINER_ERROR, CONTAINER_ERROR_IMAGE, CONTAINER_WARNING, CONTAINER_WARNING_IMAGE, LOG_CATEGORY, NOT_CLICKABLE, popDefinition

Fields inherited from class psdi.webclient.system.controller.BaseInstance

EXCEPTION_ERROR, EXCEPTION_INFO, EXCEPTION_NONE, EXCEPTION_REQUIREDFIELD, EXCEPTION_SMARTFILL, EXCEPTION_WARNING, EXCEPTION_YESNOCANCEL, FORCE_WARNING_HANDLING, NO_PROMPT_WITH_WARNING, presentationTags, PROMPT_WHEN_WARNING_EXIST

Constructor Summary

Constructors

Constructor and Description
GpsDataCollectorComponent()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Boolean	getIsLBSEnabled()
java.lang.String	getLaborCode() Retrieves the labor code
java.lang.Integer	getLBSInterval()
java.lang.Boolean	getUpdateEveryplaceTimeout() Get the system property value which controls whether to keep the session running as updates are being sent to LOCATIONLBS table even though there is no activity happening on the UI.
void	initialize() Called when the app broadcasts an "initialize" event to all components.
int	loadLaborLBS() Every time a user geo location is collected this information is stored in the LBSLOCATION table, creating or updating one record for its labor, and another record for its crew if the labor has a crew.
int	logLBSCollectionNotSupported() Prints a log message saying that LBS location data could not be retrieved.
int	logLBSCollectionPermissionDenied() Prints a log message saying that LBS location data could not be retrieved.

Methods inherited from class psdi.webclient.system.controller.BoundComponentInstance

addAttributeError, addSetValueError, applink, cleanup, clearErrors, createChangedPropList, dataRestrictionCheck, datelookup, decrement, exceptionhandled, getApplink, getBoolean, getCurrentError, getDataBean, getDataType, getDataValueInError, getErrorForRow, getExcDialogIcon, getExceptionType, getFieldInfo, getHighestErrorLevel, getInputMode, getInputModeWithoutPasswordPrefix, getLinkBack, getLongDescription, getLookupName, getQbeNameWithPrepend, getRenderIdForAutoFill, getString, getWarningList, getWarningMessages, hasChanged, hasDataChanged, hasLongDescChanged, hasLongDescription, hasReadonlyChanged, hasRequiredChanged, hasWarnings, increment, instantiatedatasrc, isDataValid, isDefault, isMasked, isOnCurrentRow, isPasswordField, isQuery, isReadOnly, isRequired, isRevert, isRowDeleted, isSmartFillEnabled, popexception, processAsyncYesNoCancel, processEdit, processIgnoreWarning, processProfile, processRevert, readOnlyCheck, removeCurrentError, render, resetIsRevert, retryErrorValues, selectvalue, setBoundAsRequired, setcurrentdate, setDataValid, setDataValueInError, updateCachedDataValue, useMaxLength

Methods inherited from class psdi.webclient.system.controller.DynamicAttributeComponent

click, dataChangedEvent, getProperty, hasAnyPropertyChanged, needsRender, resetAttribute, structureChangedEvent

Methods inherited from class psdi.webclient.system.controller.ComponentInstance

action, broadcastEvent, canChangeRowFocus, clearChangedFlag, clearUIUpdates, controlPropertyChanged, fetchtooltip, findComponentByDescriptorId, findProperty, formatLabel, formatLabel, getChildrenDesignOnly, getClickState, getComponentContainerId, getControl, getCssClass, getCurrent, getCurrentUpdates, getDesignerSelected, getErrorInfo, getFocusRenderId, getId, getId, getIdWithoutRow, getLabelForRenderId, getLabelledByRenderId, getLinkedComponentInstance, getMenuType, getOriginalProperty, getRenderId, getUpdatedAttributes, getUpdatedStyles, hasChildren, hasComponents, hasLocalProperty, hasMaskedChanged, hasUnappliedUIUpdates, hiddenByProp, hiddenByProperty, isAsyncEnabled, isChild, isComponent, isDefaultRender, isDisabled, isHoversActive, isIncluded, isOnTableFilterRow, isOnTableRow, isOnTableTitleRow, isVisible, query, renderChildComponents, renderChildrenControls, rerendering, setChangedFlag, setChangedFlag, setComponentContainerId, setControl, setFocus, setIsHoversActive, setLabelFormat, showMenu, showMenubarMenu, signout, skipRender, updateAttribute, updateStyle, updateStyle

Methods inherited from class psdi.webclient.system.controller.BaseInstance

addChild, addChild, addRefreshListener, clearChildren, clearProperties, clone, clone, getBoolean, getChildCount, getChildIndex, getChildren, getConsiderInDesigner, getDescriptor, getIdExtension, getInt, getLocalizedType, getPage, getParent, getParentInstance, getPropertyNames, getRefreshListeners, getRowNum, getSafeId, getString, getType, getWebClientSession, handleEvent, handleEvent, hasPropertyChanged, initProperty, isDynamicContainer, isOnTable, maintainControlId, removeProperty, setConsiderInDesigner, setDescriptor, setDynamicContainer, setOnTable, setParent, setProperty, setProperty, setRenderId, setType, setWebClientSession, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GpsDataCollectorComponent

public GpsDataCollectorComponent()

Method Detail

initialize

public void initialize()

Description copied from class: BoundComponentInstance

Called when the app broadcasts an "initialize" event to all components. Loads the component's properties from the mbo.

Overrides:

initialize in class BoundComponentInstance

getIsLBSEnabled

public java.lang.Boolean getIsLBSEnabled()

getLBSInterval

public java.lang.Integer getLBSInterval()

loadLaborLBS

public int loadLaborLBS()
                 throws java.rmi.RemoteException,
                        MXException

Every time a user geo location is collected this information is stored in the LBSLOCATION table, creating or updating one record for its labor, and another record for its crew if the labor has a crew. The labor entry user "LABOR" as REFOBJECT value and the labor internal ID as REFOBJECTID. If the labor is part of a crew then an additional update in made the LBSLOCATION record related to the crew record, using "AMCREW" as the REFOBJECT value. This update for the crew record in LBSLOCATION table only happens if the checkbox AMCREW.LBSLABORBASED is set to true.

Returns:

EVENT_HANDLED

Throws:

java.rmi.RemoteException

MXException

logLBSCollectionPermissionDenied

public int logLBSCollectionPermissionDenied()
                                     throws java.rmi.RemoteException,
                                            MXException

Prints a log message saying that LBS location data could not be retrieved. Error: PERMISSION DENIED.

Throws:

java.rmi.RemoteException

MXException

logLBSCollectionNotSupported

public int logLBSCollectionNotSupported()
                                 throws java.rmi.RemoteException,
                                        MXException

Prints a log message saying that LBS location data could not be retrieved. Error: NOT SUPPORTED.

Throws:

java.rmi.RemoteException

MXException

getLaborCode

public java.lang.String getLaborCode()
                              throws java.rmi.RemoteException,
                                     MXException

Retrieves the labor code

Throws:

java.rmi.RemoteException

MXException

getUpdateEveryplaceTimeout

public java.lang.Boolean getUpdateEveryplaceTimeout()

Get the system property value which controls whether to keep the session running as updates are being sent to LOCATIONLBS table even though there is no activity happening on the UI. This also prevents the session timeout warning dialog from popping up all the time. This will only be done if the system property mxe.map.everyplacetimeout is set to true.

Returns:

true - the default

Throws:

java.rmi.RemoteException

MXException