com.ibm.tivoli.maximo.miniapps.scheduler

Class AbstractTreeGridMiniAppBean

java.lang.Object

psdi.webclient.system.beans.WebClientBean

psdi.webclient.system.beans.DataBean

com.ibm.tivoli.maximo.miniapps.scheduler.AbstractTreeGridMiniAppBean

All Implemented Interfaces:

CssFilterable, HasOptions, ResetListener, SKDTemplateResolver, java.util.EventListener, javax.servlet.http.HttpSessionBindingListener, DataBeanListener

Direct Known Subclasses:

BaseLargeGanttView, BaseTreeGridMiniAppBean, GWAResourceScheduleView

public abstract class AbstractTreeGridMiniAppBean
extends DataBean
implements HasOptions, CssFilterable, ResetListener, SKDTemplateResolver

Provides the base class for integrating a TreeGrid mini app

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractTreeGridMiniAppBean.BucketInfo
static class	AbstractTreeGridMiniAppBean.ShiftInfo

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Locale	calLocale
protected java.util.TimeZone	calTimezone
protected TreeGridUtil.ITGSerializationHelper	helper
protected SKDState	lastSavedState
protected java.util.Properties	props
protected java.util.List	readOnlyRightClickMenus
static java.lang.String	SCHEDULER_MSG_GROUP
static java.lang.String	SKD_BUILD_ID
protected java.util.Map	templates
static java.lang.String	TESTIDS_ENABLED_PROPERTY
protected UIOptions	uiOptions
protected com.ibm.json.java.JSONObject	userLocalizedTreeGridLabels

Fields inherited from class psdi.webclient.system.beans.DataBean

ALL_BOOKMARKS, ALL_RECORDS, alwaysSelected, app, appDefaultValues, appName, appWhere, ATTR_COLUMN, ATTR_DEFAULT, ATTR_QBE, ATTR_READONLY, ATTR_REFRESH_TABLE, ATTR_REQUIRED, ATTR_RESET, attributes, boundAttributes, boundInputs, closingBean, conditionallyRequired, creatingEvent, currentQuery, currentQueryDescription, currentRecordData, currentRow, defaultDynamicQbe, defaultOrderBy, defaultQbe, defaultUserValues, descAttributeId, designerMboName, dialogReferences, dynamicDefaults, emptyOnClear, ermEntity, esigvalidated, eventrow, fetchData, globalAppTableRetain, hasTableData, hasUnappliedAppDefaults, hasUnappliedQbeDefaults, keyAttribute, keyAttributes, lastEventHandled, lastfetchedindex, listeners, listTableModified, listTableRetain, LOG_CATEGORY, MAX_TABLEROWS, mboName, mbosetfromzombie, mboSetRemote, multiQbe, newRowUnedited, orderBy, parent, parentRelationship, propCache, qbeAttributes, qualrestrict, queryDescBeforeReviseAction, queryNameBeforeReviseAction, refreshList, refreshQbe, removeOnCancel, requiredFields, resetList, resetRemote, returnAttribute, returnComponent, returnComponentlId, ROW_DELETE, ROW_IGNORE, ROW_INSERT, ROW_MODIFY, rowsperpage, saveCount, savedFilterSettings, savedQbeAttributes, screenDesignMode, smartFillValue, startEmpty, startrow, TABLE_ALL_SELECTED, TABLE_AT_FIRST_PAGE, TABLE_AT_FIRST_ROW, TABLE_AT_LAST_PAGE, TABLE_AT_LAST_ROW, TABLE_DETAILS_EXPANDED, TABLE_EXPANDED, TABLE_FILTER_EXPANDED, TABLE_FILTERED, TABLE_REFRESH_ALL_ROWS, TABLE_REFRESH_FILTER, TABLE_REFRESH_ROW, TABLE_REFRESH_TITLE, TABLE_ROW_CHANGED, TABLE_START_EMPTY, TABLE_SUBSELECT_ON, TABLE_USE_SUBSELECT, tableAttributes, tableData, tableDataInvalid, tableStateFlags, userQbeNotCommited, userWhereClause, zombieData

Fields inherited from class psdi.webclient.system.beans.WebClientBean

clientSession, creator, EVENT_CONTINUE, EVENT_HANDLED, EVENT_STOP_ALL, id, sessionContext

Constructor Summary

Constructors

Constructor and Description
AbstractTreeGridMiniAppBean()

Method Summary

Modifier and Type	Method and Description
void	addFilterToggle(UIOptions opts)
void	addLinkToWorkViewFilter(UIOptions opts, boolean create, boolean initialState)
protected void	addMessages(com.ibm.json.java.JSONObject msgs) SubClasses can add additional messages for the client
void	addQuickSearch(UIOptions opts)
protected void	addResourceDisplay(UIOptions opts)
void	addToggleDependencies(UIOptions opts, boolean create)
void	appendCss(java.lang.StringBuilder sb, java.lang.String key, java.lang.String value)
void	async_export_echo(WebClientSession sess)
TMenu	async_get_table_context_menu(WebClientSession sess, java.lang.String projectId, java.lang.String id, java.lang.String column, java.lang.String value) Called for an ITEM to fetch the Menu for a given item.
com.ibm.json.java.JSONObject	async_load_text(WebClientSession sess) Used to load the localized text for TreeGrid
void	async_push_client_message() This is a sample "handler" showing how you would push a message from the sever to the browser ui.
ReplyBuilder	async_upload_changes(WebClientSession sess) This is called by the TreeGrid component, in the browser, when it has changes that it needs to sync with the server.
com.ibm.json.java.JSONObject	async_upload_state(WebClientSession sess, java.lang.String cfgid, java.lang.String cookie) Accept current state from the UI for this bean's view, and save it for later.
Supplier	beanSupplier()
java.lang.Object	callBeanMethod(java.lang.String method, java.lang.Class[] paramTypes, java.lang.Object[] params)
java.lang.Object	callMethod(java.lang.String methodName, java.lang.Class[] paramTypes, java.lang.Object[] params)
static java.lang.String	CfgId(java.lang.String base)
void	clearSavedState()
protected TreeGridUtil.ITGSerializationHelper	createSerializationHelper(UserInfo userInfo)
protected UIOptions	createUIOptions(java.lang.String projectId) Create the UIOptions for the project
java.lang.String	filterCss(java.lang.String css, MiniAppControl control)
abstract Range	getActualStartEnd()
protected java.lang.String	getAppDescForApp(java.lang.String appName, UserInfo userInfo) Return the description from maxapps table
java.lang.String	getApplicationResource(java.lang.String path)
protected java.lang.String	getAppMboString(java.lang.String field)
protected boolean	getAppMboYORN(java.lang.String field)
java.lang.String	getAppName() Return the configure AppName for the Scheduler MiniApp, as configured in the presenation xml file
java.lang.String	getBaseImageUrl()
protected java.lang.Boolean	getBoolean(com.ibm.json.java.JSONObject o, java.lang.String prop)
abstract Range	getCalculatedProjectMinMax()
WebClientSession	getClientSession()
protected abstract TMenu	getContextMenuFor(TMenu menu, UserInfo userInfo, java.lang.String projectId, java.lang.String propName, java.lang.String propValue, java.lang.String[] ids) Given the parameters, return a TMenu (TreeGrid Menu) context menu.
java.lang.String	getCurrentProjectId() Gets the current project ID that we are working with
protected java.util.Date	getDate(com.ibm.json.java.JSONObject o, java.lang.String prop)
java.lang.String	getLastKnownState() Load the last Known state for this bean, if it has not been loaded already
IMXActivity	getModAvailForDate(IMXResource mxr, IMXGanttModel model, java.util.Date d)
protected GanttTextResolver.TextFunction	getModelFunctionImpl()
java.util.Map	getOptions() any options defined here, are passed to the contructor of the Dojo MiniApp control (child controls, such as GanttWidget, ResourceViewWidget,etc)
com.ibm.json.java.JSONObject	getPresentationOptions() Returns the "options" attribute, parsed as JSON from the presentation element.
protected java.lang.String	getProjectId(com.ibm.json.java.JSONObject projectOptions) return the project id from the JSONObject options, or if null, then return the current project id.
MboRemote	getProjectMbo()
protected com.ibm.json.java.JSONObject	getProjectOptions(java.lang.String projectId) Creates a JSONObject project options with the given ID
java.util.Properties	getSchedulerProperties()
TreeGridUtil.ITGSerializationHelper	getSerializationHelper()
AbstractTreeGridMiniAppBean.ShiftInfo	getShiftBreakInfoForDate(IMXResource mxr, IMXGanttModel model, java.util.Date d) Add the WorkPeriod information to the TreeGrid UI
AbstractTreeGridMiniAppBean.ShiftInfo	getShiftWorkPeriodInfoForDate(IMXGanttModel model, java.util.Date d) Returns the ShiftInfo for the given date in the model, if the model has shift information loaded.
java.util.List	getShiftWorkPeriodInfoForDate(IMXGanttModel sched, java.util.Properties props, java.util.Date d) Find Shift Info for a given date in the Schedule.
AbstractTreeGridMiniAppBean.ShiftInfo	getShiftWorkPeriodInfoForDate(IMXResource mxr, IMXGanttModel model, java.util.Date d) Add the WorkPeriod information to the TreeGrid UI
SKDAppServiceBeanRemote	getSKDAppServiceBean()
static SKDAppServiceBeanRemote	getSKDAppServiceBean(WebClientSession wcs) REturns the remote reference to the service bean
java.util.TimeZone	getTimeZone()
protected DynamicTooltip	getTooltip(WebClientSession sess, IMXGanttModel model, java.lang.String col, java.lang.String id) Load the Tooltip for the given Model and ID
abstract DynamicTooltip	getTooltip(WebClientSession sess, java.lang.String projectid, java.lang.String col, java.lang.String id) Returns a Tooltip HTML for a given activity id
abstract DynamicTooltip	getTooltipForCPM(WebClientSession sess, java.lang.String projectid, java.lang.String fromId, java.lang.String toId) Returns a Tooltip HTML for a given activity id's CPM
abstract DynamicTooltip	getTooltipForDate(WebClientSession sess, java.lang.String projectid, java.lang.String col, java.lang.String id, long date)
DynamicTooltip	getTooltipForDateInSchedule(IMXGanttModel schedule, java.util.Properties props, long date)
DynamicTooltip	getTooltipForPoint(java.lang.String id, int pointIndex)
UIOptions	getUIOptions() Convenience method for getting options by defaulting the project id
protected UIOptions	getUIOptions(java.lang.String projectId) Get the UI Options/Hints for rendering TreeGrid
UserInfo	getUserInfo()
void	initializeProjectData()
static boolean	isAiviationLicensePresent(WebClientSession sess) Returns true, if the aviation license is present, otherwise false.
static boolean	isAiviationMROLicensePresent(WebClientSession sess) Returns true, if the aviation license is present, otherwise false.
protected boolean	isDefaultScenario()
boolean	isGUIMirrored()
static boolean	isLicensePresent(java.lang.String lic)
static boolean	isLicensePresent(WebClientSession sess, java.lang.String lic)
protected boolean	isScenario()
protected boolean	isScenarioOrSnapshot()
boolean	isShowingWeather()
protected boolean	isSnapshot()
java.lang.String	label(java.lang.String key)
java.lang.String	label(java.lang.String key, java.lang.String def)
java.lang.String	loadMiniAppResource(java.lang.String path)
protected java.util.Properties	loadSchedulerProperties()
SKDUIInfo	loadSKDUIInfo() Load the Scheduler UI Info data for the given application.
java.lang.String	loadTemplate(java.lang.String id)
java.lang.String	loadTooltip(java.lang.String id)
java.lang.Object	on_handle_applink_menu_item(WebClientSession sess, java.lang.String id, java.lang.String action, java.lang.String values) Called form the Browser Client with the Activity ID and Action.
void	onReset() OnReset is called whenever we need to clear the state of our beean.
protected void	populateErrorReply(ReplyBuilder reply, java.lang.Throwable e)
protected void	refreshToolbarItems(UIOptions uiOptions2) This is called everytime getUIOptions is called, in case, bean needs to refresh the state of the options
java.lang.String	resolveTemplate(java.lang.String templateName, MboRemote projectMbo) Return the complete template contents for the given template name
void	sendEventToTreeGrid(java.lang.String eventId, java.lang.String eventArg) Will push a Dojo topic with the given eventId as the topic and eventArg as the event message
void	setGridTitleInUIOptions(UIOptions opts, boolean readOnly)
void	setSerializationHelper(MXSerializationHelper mxSerializationHelper)
void	setupBean(WebClientSession wcs) This method must be call after the bean is instantiated.
java.util.HashMap	sortSKDAction(java.util.HashMap skdActivityActions, java.lang.String frame) Taken from scheduler applet...
Supplier	uiOptionsSupplier()
void	updateBooleanProperty(java.lang.String prop, com.ibm.json.java.JSONObject obj, IMXActivity act)
void	updateDateTimeProperty(java.lang.String prop, com.ibm.json.java.JSONObject obj, IMXActivity act)
boolean	updateIntProperty(java.lang.String prop, com.ibm.json.java.JSONObject obj, IMXActivity act) Updates the prop in obj to IMXActivity act object.
void	updateStringProperty(java.lang.String prop, com.ibm.json.java.JSONObject obj, IMXActivity act, boolean acceptEmptyString)

Methods inherited from class psdi.webclient.system.beans.DataBean

_useAllBookmarksQuery, _useAllRecsQuery, _usequery, addAttribute, addConditionalProperties, addDialogReference, addListener, addQbeAttribute, addrow, addSigOption, afterSetValue, applyValuesToSharedAttributes, applyValuesToSharedAttributes, asyncLocked, bindComponent, boundToTable, buildPortalMsg, callBeanMethod, callBeanMethod, callBeanMethod, callBeanMethod, callMethod, callMethod, callMethod, callMethod, callRemoteMethod, callRemoteMethod, cancelDialog, canCloseBean, canFetchData, changeRequiredField, checkAndDistributeRequiredError, checkESigAuthenticated, checkForAppError, checkMethodAccess, cleanup, clearBean, clearfilter, clearQbeAttributes, clearSavedFilterSettings, clearSavedQbeSettings, close, copytonewrow, count, dataChangedEvent, delete, delete, deleteAndRemove, deleteAndRemove, displaycount, duplicateMbo, execute, fetchRecordData, fetchTableData, fetchTableData, filterrows, findAndCallMethod, fireChildChangedEvent, fireDataChangedEvent, fireDataChangedEvent, fireStructureChangedEvent, fireStructureChangedEvent, getAppWhere, getAttributes, getBoolean, getBoolean, getCacheRowIndex, getColumnDate, getColumnString, getCompleteWhere, getConditionalProperties, getCurrentQueryDescription, getCurrentQueryName, getCurrentRow, getDataAsArray, getDataAsArray, getDataList, getDataList, getDataList, getDataList, getDataListFromMboSetRemote, getDate, getDefaultOrderBy, getDefaultValue, getDescAttributeId, getEndRow, getEventRowIndex, getKeyAttribute, getKeyAttributes, getLastEventHandled, getLastFetchIndex, getList, getList, getList, getLockedByDisplayName, getMbo, getMbo, getMboForUniqueId, getMboName, getMboOrZombie, getMboRowIndex, getMboSet, getMboSetData, getMboSetFromSmartFind, getMboSetFromSmartFind, getMboSetFromSmartFind, getMboSetRemote, getMboValueData, getMboValueData, getMboValueInfo, getMXSession, getNullRequiedFields, getOrderBy, getPageEndRow, getPageRowCount, getPageStartIndex, getParent, getParentRelationship, getQbe, getQbe, getQbeAttributes, getQueryDescBeforeReviseAction, getQueryNameBeforeReviseAction, getRemoteForDownload, getRemoteForLookup, getReturnAttribute, getReturnComponent, getReturnComponentId, getReturnControlId, getRowIndexFromEvent, getSavedFilterSettings, getSelectedDataAsArray, getSelectedDataAsArray, getSelection, getShowDetails, getSmartFillValue, getSortOrder, getString, getString, getTableAttributes, getTableOffset, getTableStateFlags, getTitle, getUIERMEntity, getUniqueIdFromSmartFill, getUniqueIdFromSmartFill, getUniqueIdName, getUniqueIdValue, getUserAndQbeWhere, getUserWhere, getWarnings, getWorkflowDirections, getZombie, getZombieMboValueData, handleRemoteException, handleRequiredFieldException, hasLongDescriptionText, hasLongDescriptionText, hasMboSetRemote, hasPageRows, hasRow, hasSameMboSet, hasSigOptionAccess, hasSigOptionAccess, hierarchicalmove, highlightrow, highlightrow, initialize, insert, insert, insertAtEnd, instantdelete, invalidateTableData, isAppTableRetain, isAttribute, isAttributeHidden, isAttributeHidden, isColumnSorted, isEmpty, isListTableModified, isListTableRetain, isLookupMultiSelect, isMboHidden, isMboHidden, isMboSetSame, isModifiedRow, isModifiedRow, isNewRow, isNewRow, isNewRowUnedited, isRowDeleted, isRowLocked, isSelected, isSubSelect, isTableAttribute, isTablePostionMarked, isTableRowSelected, isTableStateFlagSet, listenerChangedEvent, madeRequiredConditionally, markTablePosition, moveTo, moveToMboFromDataBean, needToAuthenticate, next, nextrow, notExist, positionState, preSaveChecks, previous, prevrow, propagateRequired, queryAllBookmarks, queryAllRecs, refreshFieldErrors, refreshTable, registerDynamicControlsWithERM, reloadTable, removeDialogReference, removeListener, removeRowOnCancel, rePosition, reserveOnePair, reset, resetDataBean, resetJSPFlags, resetQbe, resetWithSelection, restoreSavedQbeSettings, retainPosition, returnLookupValue, returnLookupValue, returnLookupValue, returnLookupValue, save, save, saveCurrentQbeSettings, scrollnext, scrollprev, select, select, selectAll, selectrecord, selectRows, sendRefreshTable, setApp, setApp, setAppDefault, setAppDefaults, setApplicationError, setAppWhere, setAsyncLock, setAttributes, setCurrentQueryDescription, setCurrentQueryName, setCurrentRecordData, setCurrentRow, setDate, setDate, setDate, setDefaultOrderBy, setDefaultQbe, setDefaultValue, setDefaultValue, setDescAttributeId, setDynamicAppDefaults, setDynamicDefault, setDynamicQbeDefaults, setEmptyOnClear, setERMOnMboSet, setEsigValidated, setEventRowIndex, setfiltervalue, setLastEventHandled, setListTableModified, setListTableRetain, setMboName, setNewRowUnedited, setOrderBy, setPageRowCount, setParent, setQbe, setQbe, setQbe, setQbe, setQbe, setQbeAttributes, setQbeCaseSensitive, setQbeDefaults, setQbeExactMatch, setQueryBySiteQbe, setQueryDescBeforeReviseAction, setQueryNameBeforeReviseAction, setRemoveOnCancel, setReturnAttribute, setReturnComponent, setReturnComponentId, setReturnControlId, setShowDetails, setSmartFillValue, setTableFlag, setupBean, setupNonPersistent, setUserDefaults, setUserWhere, setvalue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueFromComponent, smartFill, smartFill, sort, sort, sortcolumn, sortcolumn, sqlwhere, structureChangedEvent, toBeSaved, toggledeleterow, toggledetailstate, toggleselectallrows, toggleselectrow, toString, turnEmptyStateOn, unbindComponent, undelete, undelete, unselect, unselect, unselectAll, useAllBookmarksQuery, useAllRecsQuery, useqbe, usequery, useQuery, useStoredQuery, validate, validateChildren, validateClause, validateMbo, validateRow, valueBound, valueUnbound

Methods inherited from class psdi.webclient.system.beans.WebClientBean

getCreator, getId, setCreator, setId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TESTIDS_ENABLED_PROPERTY

public static final java.lang.String TESTIDS_ENABLED_PROPERTY

See Also:

Constant Field Values

SKD_BUILD_ID

public static final java.lang.String SKD_BUILD_ID

See Also:

Constant Field Values

SCHEDULER_MSG_GROUP

public static final java.lang.String SCHEDULER_MSG_GROUP

See Also:

Constant Field Values

props

protected java.util.Properties props

templates

protected java.util.Map templates

userLocalizedTreeGridLabels

protected com.ibm.json.java.JSONObject userLocalizedTreeGridLabels

lastSavedState

protected SKDState lastSavedState

helper

protected TreeGridUtil.ITGSerializationHelper helper

uiOptions

protected UIOptions uiOptions

calTimezone

protected java.util.TimeZone calTimezone

calLocale

protected java.util.Locale calLocale

readOnlyRightClickMenus

protected java.util.List readOnlyRightClickMenus

Constructor Detail

AbstractTreeGridMiniAppBean

public AbstractTreeGridMiniAppBean()

Method Detail

getSerializationHelper

public TreeGridUtil.ITGSerializationHelper getSerializationHelper()

getUserInfo

public UserInfo getUserInfo()

getAppDescForApp

protected java.lang.String getAppDescForApp(java.lang.String appName,
                                            UserInfo userInfo)
                                     throws MXException,
                                            java.rmi.RemoteException

Return the description from maxapps table

Parameters:

appName -

Returns:

description

Throws:

java.lang.Exception

MXException

java.rmi.RemoteException

addQuickSearch

public void addQuickSearch(UIOptions opts)

addToggleDependencies

public void addToggleDependencies(UIOptions opts,
                                  boolean create)

addLinkToWorkViewFilter

public void addLinkToWorkViewFilter(UIOptions opts,
                                    boolean create,
                                    boolean initialState)

addFilterToggle

public void addFilterToggle(UIOptions opts)

onReset

public void onReset()

OnReset is called whenever we need to clear the state of our beean. And reinitialize it for a new state. ie, when Maximo changes a record, etc, we need to clear the bean data, the load the state for that record

Specified by:

onReset in interface ResetListener

getAppMboString

protected java.lang.String getAppMboString(java.lang.String field)

getAppMboYORN

protected boolean getAppMboYORN(java.lang.String field)

getCurrentProjectId

public java.lang.String getCurrentProjectId()

Gets the current project ID that we are working with

Returns:

isGUIMirrored

public boolean isGUIMirrored()

setGridTitleInUIOptions

public void setGridTitleInUIOptions(UIOptions opts,
                                    boolean readOnly)
                             throws java.rmi.RemoteException,
                                    MXException

Throws:

java.rmi.RemoteException

MXException

isScenario

protected boolean isScenario()

isDefaultScenario

protected boolean isDefaultScenario()

isSnapshot

protected boolean isSnapshot()

isScenarioOrSnapshot

protected boolean isScenarioOrSnapshot()

async_export_echo

public void async_export_echo(WebClientSession sess)
                       throws java.io.IOException

Throws:

java.io.IOException

getLastKnownState

public java.lang.String getLastKnownState()
                                   throws java.io.IOException,
                                          MXException

Load the last Known state for this bean, if it has not been loaded already

Returns:

Throws:

java.io.IOException

MXException

async_upload_state

public com.ibm.json.java.JSONObject async_upload_state(WebClientSession sess,
                                                       java.lang.String cfgid,
                                                       java.lang.String cookie)
                                                throws java.rmi.RemoteException,
                                                       MXException

Accept current state from the UI for this bean's view, and save it for later.

Parameters:

sess -

cfgid -

cookie -

Returns:

Throws:

java.rmi.RemoteException

MXException

async_load_text

public com.ibm.json.java.JSONObject async_load_text(WebClientSession sess)

Used to load the localized text for TreeGrid

Parameters:

sess -

Returns:

loadSKDUIInfo

public SKDUIInfo loadSKDUIInfo()
                        throws MXException,
                               java.io.IOException

Load the Scheduler UI Info data for the given application.

Parameters:

sess -

appName -

Returns:

Throws:

MXException

java.io.IOException

async_get_table_context_menu

public TMenu async_get_table_context_menu(WebClientSession sess,
                                          java.lang.String projectId,
                                          java.lang.String id,
                                          java.lang.String column,
                                          java.lang.String value)
                                   throws java.lang.Exception

Called for an ITEM to fetch the Menu for a given item. The menu items should contain a Menu Name (display) and an action value. The Action Value will later be passed to the on_handle_conent_menu_item callback.

Parameters:

id - Activity ID

col - Table Column

Returns:

Throws:

java.lang.Exception

on_handle_applink_menu_item

public java.lang.Object on_handle_applink_menu_item(WebClientSession sess,
                                                    java.lang.String id,
                                                    java.lang.String action,
                                                    java.lang.String values)
                                             throws MXException,
                                                    java.rmi.RemoteException

Called form the Browser Client with the Activity ID and Action. The action was was the same action that was created during the

Parameters:

id -

action -

Throws:

MXException

java.rmi.RemoteException

callMethod

public java.lang.Object callMethod(java.lang.String methodName,
                                   java.lang.Class[] paramTypes,
                                   java.lang.Object[] params)
                            throws MXException,
                                   java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

callBeanMethod

public java.lang.Object callBeanMethod(java.lang.String method,
                                       java.lang.Class[] paramTypes,
                                       java.lang.Object[] params)
                                throws MXException,
                                       java.lang.NoSuchMethodException,
                                       java.rmi.RemoteException

Throws:

MXException

java.lang.NoSuchMethodException

java.rmi.RemoteException

async_upload_changes

public ReplyBuilder async_upload_changes(WebClientSession sess)

This is called by the TreeGrid component, in the browser, when it has changes that it needs to sync with the server. This does not cause a "save" but rather, it simply sets the changes to be processed when a save happens.

Parameters:

sess -

Returns:

populateErrorReply

protected void populateErrorReply(ReplyBuilder reply,
                                  java.lang.Throwable e)

getDate

protected java.util.Date getDate(com.ibm.json.java.JSONObject o,
                                 java.lang.String prop)

getTimeZone

public java.util.TimeZone getTimeZone()

getBoolean

protected java.lang.Boolean getBoolean(com.ibm.json.java.JSONObject o,
                                       java.lang.String prop)

getAppName

public java.lang.String getAppName()

Return the configure AppName for the Scheduler MiniApp, as configured in the presenation xml file

Returns:

getTooltip

public abstract DynamicTooltip getTooltip(WebClientSession sess,
                                          java.lang.String projectid,
                                          java.lang.String col,
                                          java.lang.String id)
                                   throws MXException,
                                          java.rmi.RemoteException,
                                          java.lang.InterruptedException,
                                          java.util.concurrent.ExecutionException

Returns a Tooltip HTML for a given activity id

Parameters:

sess -

projectid -

col -

id -

Returns:

Throws:

MXException

java.rmi.RemoteException

java.lang.InterruptedException

java.util.concurrent.ExecutionException

getModelFunctionImpl

protected GanttTextResolver.TextFunction getModelFunctionImpl()

getTooltipForCPM

public abstract DynamicTooltip getTooltipForCPM(WebClientSession sess,
                                                java.lang.String projectid,
                                                java.lang.String fromId,
                                                java.lang.String toId)
                                         throws MXException,
                                                java.rmi.RemoteException,
                                                java.lang.InterruptedException,
                                                java.util.concurrent.ExecutionException

Returns a Tooltip HTML for a given activity id's CPM

Parameters:

sess -

projectid -

fromid -

toid -

Returns:

Throws:

MXException

java.rmi.RemoteException

java.lang.InterruptedException

java.util.concurrent.ExecutionException

getTooltipForDate

public abstract DynamicTooltip getTooltipForDate(WebClientSession sess,
                                                 java.lang.String projectid,
                                                 java.lang.String col,
                                                 java.lang.String id,
                                                 long date)
                                          throws MXException,
                                                 java.rmi.RemoteException,
                                                 java.lang.InterruptedException,
                                                 java.util.concurrent.ExecutionException

Throws:

MXException

java.rmi.RemoteException

java.lang.InterruptedException

java.util.concurrent.ExecutionException

getTooltipForPoint

public DynamicTooltip getTooltipForPoint(java.lang.String id,
                                         int pointIndex)
                                  throws MXException,
                                         java.rmi.RemoteException,
                                         java.lang.InterruptedException,
                                         java.util.concurrent.ExecutionException

Parameters:

id -

pointIndex - Point Index in the GanttPoints for row id. Points start at index 0.

Returns:

Throws:

MXException

java.rmi.RemoteException

java.lang.InterruptedException

java.util.concurrent.ExecutionException

getProjectId

protected java.lang.String getProjectId(com.ibm.json.java.JSONObject projectOptions)

return the project id from the JSONObject options, or if null, then return the current project id.

Parameters:

projectOptions -

Returns:

getProjectOptions

protected com.ibm.json.java.JSONObject getProjectOptions(java.lang.String projectId)

Creates a JSONObject project options with the given ID

Parameters:

projectId -

Returns:

async_push_client_message

public void async_push_client_message()

This is a sample "handler" showing how you would push a message from the sever to the browser ui. The JavaScript in the browser would need to "subscribe()" to the message id that is used, which isn this case, is 'miniapp.scheduler.pushevent'. This ID can be any ID that you want to use, provided the JavaScript is subscribed to it.
In JavaScript it would look like this..

 topic.subscribe("miniapp.scheduler.pushevent", function(data) {
    alert("GOT A PUSHED MESSAGE: " + data);
 });
 

sendEventToTreeGrid

public void sendEventToTreeGrid(java.lang.String eventId,
                                java.lang.String eventArg)

Will push a Dojo topic with the given eventId as the topic and eventArg as the event message

Parameters:

eventId -

eventArg -

getPresentationOptions

public com.ibm.json.java.JSONObject getPresentationOptions()

Returns the "options" attribute, parsed as JSON from the presentation element.

Returns:

getOptions

public java.util.Map getOptions()

any options defined here, are passed to the contructor of the Dojo MiniApp control (child controls, such as GanttWidget, ResourceViewWidget,etc)

Specified by:

getOptions in interface HasOptions

isShowingWeather

public boolean isShowingWeather()
                         throws java.rmi.RemoteException,
                                MXException

Throws:

java.rmi.RemoteException

MXException

addMessages

protected void addMessages(com.ibm.json.java.JSONObject msgs)

SubClasses can add additional messages for the client

Parameters:

msgs -

getContextMenuFor

protected abstract TMenu getContextMenuFor(TMenu menu,
                                           UserInfo userInfo,
                                           java.lang.String projectId,
                                           java.lang.String propName,
                                           java.lang.String propValue,
                                           java.lang.String[] ids)
                                    throws java.lang.Exception

Given the parameters, return a TMenu (TreeGrid Menu) context menu.

Parameters:

menu -

userInfo -

projectId -

propName -

propValue -

ids -

Returns:

Throws:

java.lang.Exception

label

public java.lang.String label(java.lang.String key)

label

public java.lang.String label(java.lang.String key,
                              java.lang.String def)

sortSKDAction

public java.util.HashMap sortSKDAction(java.util.HashMap skdActivityActions,
                                       java.lang.String frame)

Taken from scheduler applet... it sorts the SKDAction menu items

Parameters:

skdActivityActions -

Returns:

appendCss

public void appendCss(java.lang.StringBuilder sb,
                      java.lang.String key,
                      java.lang.String value)

filterCss

public java.lang.String filterCss(java.lang.String css,
                                  MiniAppControl control)

Specified by:

filterCss in interface CssFilterable

getBaseImageUrl

public java.lang.String getBaseImageUrl()

loadMiniAppResource

public java.lang.String loadMiniAppResource(java.lang.String path)

getSchedulerProperties

public java.util.Properties getSchedulerProperties()
                                            throws java.io.IOException,
                                                   MXException

Throws:

java.io.IOException

MXException

loadSchedulerProperties

protected java.util.Properties loadSchedulerProperties()
                                                throws java.io.IOException,
                                                       MXException

Throws:

java.io.IOException

MXException

loadTemplate

public java.lang.String loadTemplate(java.lang.String id)
                              throws java.io.IOException,
                                     MXException

Throws:

java.io.IOException

MXException

loadTooltip

public java.lang.String loadTooltip(java.lang.String id)
                             throws java.io.IOException,
                                    MXException

Throws:

java.io.IOException

MXException

getSKDAppServiceBean

public SKDAppServiceBeanRemote getSKDAppServiceBean()
                                             throws MXException,
                                                    java.io.IOException

Throws:

MXException

java.io.IOException

getSKDAppServiceBean

public static SKDAppServiceBeanRemote getSKDAppServiceBean(WebClientSession wcs)
                                                    throws MXException,
                                                           java.io.IOException

REturns the remote reference to the service bean

Parameters:

session - HttpSession

Returns:

SKDAppServiceBeanRemote

Throws:

MXException

java.io.IOException

isAiviationLicensePresent

public static boolean isAiviationLicensePresent(WebClientSession sess)
                                         throws java.lang.Exception,
                                                java.rmi.RemoteException

Returns true, if the aviation license is present, otherwise false.

Returns:

boolean true, if acm license is present, otherwise false.

Throws:

MXException

java.rmi.RemoteException

java.lang.Exception

isAiviationMROLicensePresent

public static boolean isAiviationMROLicensePresent(WebClientSession sess)
                                            throws java.lang.Exception,
                                                   java.rmi.RemoteException

Returns true, if the aviation license is present, otherwise false.

Returns:

boolean true, if acm license is present, otherwise false.

Throws:

MXException

java.rmi.RemoteException

java.lang.Exception

isLicensePresent

public static boolean isLicensePresent(WebClientSession sess,
                                       java.lang.String lic)
                                throws java.lang.Exception,
                                       java.rmi.RemoteException

Throws:

java.lang.Exception

java.rmi.RemoteException

isLicensePresent

public static boolean isLicensePresent(java.lang.String lic)
                                throws java.lang.Exception,
                                       java.rmi.RemoteException

Throws:

java.lang.Exception

java.rmi.RemoteException

resolveTemplate

public java.lang.String resolveTemplate(java.lang.String templateName,
                                        MboRemote projectMbo)

Description copied from interface: SKDTemplateResolver

Return the complete template contents for the given template name

Specified by:

resolveTemplate in interface SKDTemplateResolver

Returns:

setupBean

public void setupBean(WebClientSession wcs)

Description copied from class: DataBean

This method must be call after the bean is instantiated. It tells the bean what it's clientSession is , the control that created the bean and the event that caused the creation of the bean. Also gets the values the orderyby, whereclause, apprestrictions, rowsperpage, and parentdatasrc properties from the control (the one that instantiated the bean) if any are set. Plus it gets the list of bound controls from the presentations control handler.

Overrides:

setupBean in class DataBean

initializeProjectData

public void initializeProjectData()

createSerializationHelper

protected TreeGridUtil.ITGSerializationHelper createSerializationHelper(UserInfo userInfo)

createUIOptions

protected UIOptions createUIOptions(java.lang.String projectId)
                             throws MXException,
                                    java.io.IOException

Create the UIOptions for the project

Parameters:

projectId -

Returns:

Throws:

MXException

java.io.IOException

getUIOptions

protected UIOptions getUIOptions(java.lang.String projectId)
                          throws java.io.IOException,
                                 MXException

Get the UI Options/Hints for rendering TreeGrid

Parameters:

projectId -

Returns:

Throws:

java.io.IOException

MXException

refreshToolbarItems

protected void refreshToolbarItems(UIOptions uiOptions2)

This is called everytime getUIOptions is called, in case, bean needs to refresh the state of the options

Parameters:

uiOptions2 -

getUIOptions

public UIOptions getUIOptions()

Convenience method for getting options by defaulting the project id

Returns:

addResourceDisplay

protected void addResourceDisplay(UIOptions opts)

setSerializationHelper

public void setSerializationHelper(MXSerializationHelper mxSerializationHelper)

clearSavedState

public void clearSavedState()

getApplicationResource

public java.lang.String getApplicationResource(java.lang.String path)

getShiftWorkPeriodInfoForDate

public java.util.List getShiftWorkPeriodInfoForDate(IMXGanttModel sched,
                                                    java.util.Properties props,
                                                    java.util.Date d)
                                             throws java.io.IOException

Find Shift Info for a given date in the Schedule.

Parameters:

sched - Schedule

props - Schedule Properties

d - date in schedule

Throws:

java.io.IOException

getTooltipForDateInSchedule

public DynamicTooltip getTooltipForDateInSchedule(IMXGanttModel schedule,
                                                  java.util.Properties props,
                                                  long date)
                                           throws MXException,
                                                  java.rmi.RemoteException,
                                                  java.lang.InterruptedException,
                                                  java.util.concurrent.ExecutionException

Throws:

MXException

java.rmi.RemoteException

java.lang.InterruptedException

java.util.concurrent.ExecutionException

getActualStartEnd

public abstract Range getActualStartEnd()

getCalculatedProjectMinMax

public abstract Range getCalculatedProjectMinMax()

getClientSession

public WebClientSession getClientSession()

beanSupplier

public Supplier beanSupplier()

uiOptionsSupplier

public Supplier uiOptionsSupplier()

getShiftWorkPeriodInfoForDate

public AbstractTreeGridMiniAppBean.ShiftInfo getShiftWorkPeriodInfoForDate(IMXGanttModel model,
                                                                           java.util.Date d)
                                                                    throws java.io.IOException

Returns the ShiftInfo for the given date in the model, if the model has shift information loaded. IF multiple Shifts overlapp, then only the first one is returned

Parameters:

gantt -

model -

Throws:

java.io.IOException

getShiftWorkPeriodInfoForDate

public AbstractTreeGridMiniAppBean.ShiftInfo getShiftWorkPeriodInfoForDate(IMXResource mxr,
                                                                           IMXGanttModel model,
                                                                           java.util.Date d)
                                                                    throws java.io.IOException

Add the WorkPeriod information to the TreeGrid UI

Parameters:

gantt -

model -

Throws:

java.io.IOException

getModAvailForDate

public IMXActivity getModAvailForDate(IMXResource mxr,
                                      IMXGanttModel model,
                                      java.util.Date d)

getShiftBreakInfoForDate

public AbstractTreeGridMiniAppBean.ShiftInfo getShiftBreakInfoForDate(IMXResource mxr,
                                                                      IMXGanttModel model,
                                                                      java.util.Date d)
                                                               throws java.io.IOException

Add the WorkPeriod information to the TreeGrid UI

Parameters:

gantt -

model -

Throws:

java.io.IOException

getTooltip

protected DynamicTooltip getTooltip(WebClientSession sess,
                                    IMXGanttModel model,
                                    java.lang.String col,
                                    java.lang.String id)
                             throws MXException,
                                    java.rmi.RemoteException,
                                    java.lang.InterruptedException,
                                    java.util.concurrent.ExecutionException

Load the Tooltip for the given Model and ID

Parameters:

sess -

model -

col -

id -

Returns:

Throws:

MXException

java.rmi.RemoteException

java.lang.InterruptedException

java.util.concurrent.ExecutionException

updateDateTimeProperty

public void updateDateTimeProperty(java.lang.String prop,
                                   com.ibm.json.java.JSONObject obj,
                                   IMXActivity act)

updateStringProperty

public void updateStringProperty(java.lang.String prop,
                                 com.ibm.json.java.JSONObject obj,
                                 IMXActivity act,
                                 boolean acceptEmptyString)

updateIntProperty

public boolean updateIntProperty(java.lang.String prop,
                                 com.ibm.json.java.JSONObject obj,
                                 IMXActivity act)

Updates the prop in obj to IMXActivity act object. Returns true if the value is actually updated.

Parameters:

prop -

obj -

act -

Returns:

if activity was updated

updateBooleanProperty

public void updateBooleanProperty(java.lang.String prop,
                                  com.ibm.json.java.JSONObject obj,
                                  IMXActivity act)

CfgId

public static java.lang.String CfgId(java.lang.String base)

getProjectMbo

public MboRemote getProjectMbo()
                        throws java.rmi.RemoteException,
                               MXException

Throws:

java.rmi.RemoteException

MXException