psdi.webclient.beans.report

Class ReportScheduleCommonBean

java.lang.Object

psdi.webclient.system.beans.WebClientBean

psdi.webclient.system.beans.DataBean

psdi.webclient.beans.report.ReportScheduleCommonBean

All Implemented Interfaces:

java.util.EventListener, javax.servlet.http.HttpSessionBindingListener, DataBeanListener

Direct Known Subclasses:

ReportSchedAllBean, ReportSchedBean, SchedConfirmBean

public abstract class ReportScheduleCommonBean
extends DataBean

Inherit this abstract class in order to use standard validation and fixes on ReportSchedule MBOs at your Report Schedule Bean classes.
This is an implementation of the Template Method Pattern.

Since:

7.5

See Also:

ReportSchedAllBean}, {@link ReportSchedBean}, {@link SchedConfirmBean}

Field Summary

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
ReportScheduleCommonBean()

Method Summary

Modifier and Type	Method and Description
protected void	checkEmailField(MboRemote reportSched, MboRemote reportRemote) Performs checks on REPORTSCHED.EMAILUSERS: If REPORTSCHED.EMAILUSERS is null or empty. Calls checkEmailTargets()
protected void	checkEmailTargets(MboRemote reportSched) Performs checks on REPORTSCHED.EMAILUSERS: Checks if each email address correspond to a Maximo User e-mail; validation is done against EMAIL.EMAILADDRESS entries.
protected void	checkRecurringSchedule(MboRemote reportSched, MboRemote reportRemote) Performs check only if the scheduled report set as recurring: REPORTSCHED.SCHEDULE is not null or empty
protected void	checkRunOnceSchedule(MboRemote reportSched, MboRemote reportRemote) Performs check only if the scheduled report set to run once: REPORTSCHED.ONCEDATETIME is not null
protected void	fixEmailSubject(MboRemote reportSched, MboRemote reportRemote) E-mail Subject (REPORTSCHED.EMAILSUBJECT) should not be null, defaulting to scheduled report name (REPORT.DESCRIPTION).
protected void	fixReportSchedule(MboRemote reportScheduleMbo) Automated fixes to reports scheduling data.
protected MboRemote	getReport(MboRemote reportSched) Returns the REPORT entry attached to this REPORTSCHED by the REPORT relationship.
protected void	initialize() Typically called after the DataBean gets a new MboSetRemote On the MboSetRemote it sets the app, the app defaults, user defaults If the remote is an instanceof NonPersistentMboSetRemote then setup is called on it and sets the current row to 0.
protected void	verifyReportSchedule(MboRemote reportScheduleMbo) Verifies if data on report scheduling is good to be saved.

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, 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, 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

Constructor Detail

ReportScheduleCommonBean

public ReportScheduleCommonBean()

Method Detail

initialize

protected void initialize()
                   throws MXException,
                          java.rmi.RemoteException

Description copied from class: DataBean

Typically called after the DataBean gets a new MboSetRemote On the MboSetRemote it sets the app, the app defaults, user defaults If the remote is an instanceof NonPersistentMboSetRemote then setup is called on it and sets the current row to 0. If the DataBean isn't bound to a table then initialize fetches the first mbo (sets the current row to 0). If this method is overridden under most case you will want to call super.initalize at the end of the the new initialize method.

Overrides:

initialize in class DataBean

Throws:

MXException

java.rmi.RemoteException

verifyReportSchedule

protected final void verifyReportSchedule(MboRemote reportScheduleMbo)
                                   throws MXException

Verifies if data on report scheduling is good to be saved.
Template Method Pattern

Parameters:

reportScheduleMbo - MboSetRemote containing REPORTSCHED entries

Throws:

MXException - if fails on any check

fixReportSchedule

protected final void fixReportSchedule(MboRemote reportScheduleMbo)
                                throws MXException

Automated fixes to reports scheduling data.
Template Method Pattern

Parameters:

reportScheduleMbo -

Throws:

MXException

getReport

protected MboRemote getReport(MboRemote reportSched)
                       throws MXException,
                              java.rmi.RemoteException,
                              MXApplicationException

Returns the REPORT entry attached to this REPORTSCHED by the REPORT relationship.

Parameters:

reportSched -

Returns:

MboRemote instance for the Report MBO attached to given ReportSchedule.

Throws:

MXException

java.rmi.RemoteException

MXApplicationException - - if not REPORT was found.

checkEmailField

protected void checkEmailField(MboRemote reportSched,
                               MboRemote reportRemote)
                        throws MXException,
                               java.rmi.RemoteException,
                               MXApplicationException

Performs checks on REPORTSCHED.EMAILUSERS:

1. If REPORTSCHED.EMAILUSERS is null or empty.
2. Calls checkEmailTargets()

Parameters:

reportSched -

reportRemote -

Throws:

MXException

java.rmi.RemoteException

MXApplicationException - - if 1 or 2 fails

checkEmailTargets

protected void checkEmailTargets(MboRemote reportSched)
                          throws java.rmi.RemoteException,
                                 MXException,
                                 MXApplicationException

Performs checks on REPORTSCHED.EMAILUSERS:

1. Checks if each email address correspond to a Maximo User e-mail;
   validation is done against EMAIL.EMAILADDRESS entries.

Parameters:

addresses - - a String list of addresses to be checked

Throws:

MXApplicationException - - case one or more addresses are not valid

java.rmi.RemoteException

MXException

MXApplicationException - - if fails.

fixEmailSubject

protected void fixEmailSubject(MboRemote reportSched,
                               MboRemote reportRemote)
                        throws MXException,
                               java.rmi.RemoteException

E-mail Subject (REPORTSCHED.EMAILSUBJECT) should not be null, defaulting to scheduled report name (REPORT.DESCRIPTION).

Parameters:

reportSched -

reportRemote -

Throws:

MXException

java.rmi.RemoteException

checkRunOnceSchedule

protected void checkRunOnceSchedule(MboRemote reportSched,
                                    MboRemote reportRemote)
                             throws MXException,
                                    java.rmi.RemoteException,
                                    MXApplicationException

Performs check only if the scheduled report set to run once:

1. REPORTSCHED.ONCEDATETIME is not null

Parameters:

reportSched -

reportRemote -

Throws:

MXException

java.rmi.RemoteException

MXApplicationException - - if fails

checkRecurringSchedule

protected void checkRecurringSchedule(MboRemote reportSched,
                                      MboRemote reportRemote)
                               throws MXException,
                                      java.rmi.RemoteException,
                                      MXApplicationException

Performs check only if the scheduled report set as recurring:

1. REPORTSCHED.SCHEDULE is not null or empty

Parameters:

reportSched -

reportRemote -

Throws:

MXException

java.rmi.RemoteException

MXApplicationException - - if it fails.