com.ibm.tivoli.maximo.skd.service

Class SKDAsyncJobSubmitter

java.lang.Object

psdi.mbo.MboSet

psdi.mbo.NonPersistentMboSet

psdi.common.asyncjob.AsyncJobSubmitter

com.ibm.tivoli.maximo.skd.service.SKDAsyncJobSubmitter

All Implemented Interfaces:

java.rmi.Remote, MboAccessInterface, MboConstants, MboSetRemote, NonPersistentMboSetRemote, MaxRemoteProxy, Transactable, FixedLoggerNames, FixedLoggers

public class SKDAsyncJobSubmitter
extends AsyncJobSubmitter

Field Summary

Fields inherited from class psdi.mbo.MboSet

dmDeploySet, dmDeploySkipFieldValidation, fetchStopLimitEnabled, LOOKUPMAXROW, maxSorterSize, mboCountCleanuplist, mboVec, mrdVec, perfStats, strNoBaseLangValueEntered, toBeSaved

Fields inherited from interface psdi.mbo.MboSetRemote

INSERTONLY, INSERTORUPDATE, UPDATEONLY

Fields inherited from interface psdi.mbo.MboConstants

ALLROWS, CHANGEDBY_USER, COUNT_ADDITIONS, COUNT_AFTERSAVE, COUNT_DATABASE, COUNT_DELETED, COUNT_EXISTING, DBCONFIG, DELAYVALIDATION, DELAYVALIDATIONONLY, DISCARDABLE, GOTCOMPLETEWHERE, HIDDEN, NO_RELATEDMBOS_OF_OWNERSCHILDREN_FETCH, NOACCESSCHECK, NOACTION, NOADD, NOCOMMIT, NODELETE, NONE, NOOVERWRITE, NOSAVE, NOSETVALUE, NOUPDATE, NOVALIDATION, NOVALIDATION_AND_NOACTION, NOVALIDATION_AND_NOACTION_ALLOWCROSSOVER, READONLY, REBUILD, REQUIRED, SAMEVALUEVALIDATION, SETBYPARENT, USER

Fields inherited from interface psdi.util.logging.FixedLoggers

APPLOGGER, CRONTASKLOGGER, CRONTASKMGRLOGGER, CRONTASKMGRSQLLOGGER, DBCONNECTIONLOGGER, DDLOGGER, DMLOGGER, EVENTLOGGER, EXCEPTIONLOGGER, MAILLOGGER, MAXIMOLOGGER, MTLOGGER, NULLMBOPOINTER, SECURITY, SENDFAILEDLOGGER, SERVICELOGGER, SQLLOGGER

Fields inherited from interface psdi.util.logging.FixedLoggerNames

appenderPrefix, LOGGERNAME_APP, LOGGERNAME_CRONTASK, LOGGERNAME_CRONTASKMGR, LOGGERNAME_DBCONNECTION, LOGGERNAME_DD, LOGGERNAME_DM, LOGGERNAME_DMPREVIEW, LOGGERNAME_EVENT, LOGGERNAME_EXCEPTION, LOGGERNAME_MAIL, LOGGERNAME_MAXIMO, LOGGERNAME_MT, LOGGERNAME_NULLMBOPOINTER, LOGGERNAME_SECURITY, LOGGERNAME_SENDFAILED, LOGGERNAME_SERVICE, LOGGERNAME_SQL, LOGGERNAME_SQL_CRONTASKMGR, LOGGERNAME_TXN, loggerPrefix

Constructor Summary

Constructors

Constructor and Description
SKDAsyncJobSubmitter(MboServerInterface ms) Construct the set of Custom Mbos.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAsyncJobHandlerClassName() Returns the job handler class name that will be written to the queue when job is created.
java.lang.String	getCompleteWhereClause() Get the where clause to identify one or more records of the main object that the async process is to apply on.
java.lang.String	getDescription() Returns the description of the particular job, it is not the general description of this type of the job, it is the description that user enters to describe the particular job.
boolean	getEmail() Gets whether email will be sent for this job.
java.lang.String	getEmailAddress() Gets the email address that will be sent for this job.
java.lang.String	getJobName() Get the name of the job.
protected Mbo	getMboInstance(MboSet ms) The derived class needs to provide the actual non-persistent object
java.lang.String	getObjectName() Returns the main object name that this async process will operate on.
boolean	isImmediate() Whether this job is foreground.
void	overwriteJobDefault(MboRemote queue) Overwrite this method if you don't need to overwrite execute() but need to change the default values of the job, such as userid, locale.
void	setDescription(java.lang.String description) Sets the Job description.
void	setJobName(java.lang.String jobName) Sets the Job name.

Methods inherited from class psdi.common.asyncjob.AsyncJobSubmitter

createJobEntry, execute, getParameters

Methods inherited from class psdi.mbo.NonPersistentMboSet

count, execute, isClosed, setMboSetInfo, setup, toBeSaved

Methods inherited from class psdi.mbo.MboSet

abortSql, add, add, addAliasForML, addAliasForML, addAtEnd, addAtEnd, addAtIndex, addAtIndex, addFakeAtEnd, addFederatedMboToSorter, addJoinedAttribute, addMbo, addMbo, addSubQbe, addSubQbe, addSubQbe, addSubQbe, addToEndOfSelectStatement, addWarning, addWarnings, appendToWhere, applyAppSpecificAuthorization, applyRowSecurity, avg, canAdd, cancelAndClose, checkMethodAccess, checkMethodAccess, cleanup, clear, clearBatchedPreparedStmt, clearBatchedPreparedStmts, clearESigTransactionIdThread, clearESigTransIDForAdmin, clearIgnoredAutokeyAttrs, clearLongOpPipe, clearToBeSaved, clearTransactionReference, clearWarnings, close, commit, commitTransaction, copy, copy, copy, copyForDM, count, countAndCleanup, countAndCleanup, deleteAll, deleteAll, deleteAndRemove, deleteAndRemove, deleteAndRemove, deleteAndRemove, deleteAndRemove, deleteAndRemoveAll, deleteAndRemoveAll, deleteMbo, determineRequiredFieldsFromERM, dump, earliestDate, enableMethod, executeBatch, fetchNext, findAllNullRequiredFields, findByIntegrationKey, findKey, fireEventsAfterDB, fireEventsAfterDBCommit, fireEventsBeforeDB, forceDBSort, getAllAppAlwaysFieldFlags, getAllowQualifiedRestriction, getAlwaysFlags, getAlwaysFlags, getApp, getAppAlwaysFieldFlags, getAppWhere, getAttrRestrictions, getBoolean, getByte, getBytes, getClientLocale, getClientTimeZone, getCompleteWhere, getCurrentPosition, getDate, getDBFetchMaxRows, getDefaultValue, getDefaultValueHash, getDouble, getERMEntity, getESigTransactionId, getExcludeMeFromPropagation, getFlags, getFloat, getFromClause, getIgnoredAutokeyAttrs, getInsertCompanySet, getInsertItemSet, getInsertOrg, getInsertSite, getInt, getJspDefaultValueHash, getKeyAttributes, getList, getList, getLong, getMaxAppsWhere, getMaxMessage, getMbo, getMbo, getMboCtx, getMboForUniqueId, getMboLogger, getMboServer, getMboSetData, getMboSetData, getMboSetInfo, getMboSetRetainMboPositionData, getMboSetRetainMboPositionInfo, getMboSetValueData, getMboSetValueData, getMboValueData, getMboValueData, getMboValueData, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMLFromClause, getMultiSiteWhere, getMXTransaction, getName, getOrderBy, getOwner, getParentApp, getPreparedStmt, getProfile, getProxy, getQbe, getQbe, getQbe, getQbeSiteAuthorization, getQbeWhere, getQualifiedWhere, getQueryTimeout, getRelationName, getRelationship, getRetainRecordLimit, getRowRestrictions, getSecurityLogger, getSelectClause, getSelectClause, getSelection, getSelectionWhere, getSelectWhereClause, getSetOrderByForUI, getSharedMboSet, getSize, getSkipFirstNRows, getSqlLogger, getSQLOptions, getString, getTranslator, getTxnPropertyMap, getUserAndQbeWhere, getUserInfo, getUserName, getUserPrefWhere, getUserWhere, getUserWhere, getWarnings, getWhere, getZombie, handleMLMbo, handleMLMbo, hasMLQbe, hasQbe, hasWarnings, ignoreAutokeyAttr, ignoreAutokeyAttr, ignoreQbeExactMatchSet, includeRelatedMbosOfOwnersChildren, incrementDeletedCount, init, init, initDataDictionary, insertDeltaRow, insertMbo, isBasedOn, isDeltaStorage, isDMDeploySet, isDMSkipFieldValidation, isDownloadSet, isEAuditFieldModified, isEAuditNeeded, isEmpty, isESigFieldModified, isESigNeeded, isESigNeeded, isFlagSet, isIgnoreQbeExactMatchSet, isInMemorySort, isJoinedAttribute, isLookup, isNull, isQbeCaseSensitive, isQbeExactMatch, isRetainMboPosition, isRetainRecordEnabled, isTableDomainLookup, latestDate, locateMbo, logESigVerification, logRowUpdatedException, max, min, moveFirst, moveLast, moveNext, movePrev, moveTo, moveToKey, newMboIndex, notExist, positionState, processML, remove, remove, remove, removeAllJoinedAttributes, removeCtx, removeJoinedAttribute, reset, resetForRefreshOnSave, resetQbe, resetWithSelection, rollback, rollbackToCheckpoint, rollbackToCheckpoint, rollbackTransaction, save, save, save, save, saveMbos, saveTransaction, select, select, select, selectAll, setAllowQualifiedRestriction, setApp, setAppAlwaysFieldFlag, setAppWhere, setAutoKeyFlag, setBindValueAsBytes, setDBFetchMaxRows, setDefaultOrderBy, setDefaultValue, setDefaultValue, setDefaultValues, setDefaultValues, setDiscardableFlag, setDMDeploySet, setDMSkipFieldValidation, setDownloadSet, setEAuditFieldModified, setERMEntity, setESigFieldModified, setExcludeMeFromPropagation, setFederatedResources, setFlag, setFlag, setFlags, setInsertCompanySet, setInsertItemSet, setInsertOrg, setInsertSite, setLastESigTransId, setLogLargFetchResultDisabled, setMboCtx, setMXTransaction, setNoNeedtoFetchFromDB, setNoSaveFlag, setOrderBy, setOrderByNVL, setOverrideSelectClause, setOverrideSelectFromClause, setOverrideSelectWhereClause, setOwner, setPreserveOrderByCase, setProxy, setQbe, setQbe, setQbe, setQbe, setQbe, setQbeCaseSensitive, setQbeCaseSensitive, setQbeExactMatch, setQbeExactMatch, setQbeOperatorOr, setQueryBySiteQbe, setQueryTimeout, setRelationName, setRelationship, setRequiedFlagsFromERM, setRetainMboPosition, setSetOrderByForUI, setSkipFirstNRows, setSQLOptions, setTableDomainLookup, setTxnPropertyMap, setupLongOpPipe, setUserWhere, setUserWhereAfterParse, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueNull, setValueNull, setWhere, setWhereQbe, smartFill, smartFill, smartFind, smartFind, smartFind, smartFind, sort, splitOrderBy, startCheckpoint, startCheckpoint, sum, undeleteAll, undoTransaction, unselect, unselect, unselect, unselectAll, updateMbo, updateMboSetRetainMboPositionData, updateRelatedMboSetRetainMboPositionData, useStoredQuery, validate, validateTransaction, verifyESig

Methods inherited from class java.lang.Object

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

Methods inherited from interface psdi.mbo.MboSetRemote

abortSql, add, add, addAtEnd, addAtEnd, addAtIndex, addAtIndex, addFakeAtEnd, addSubQbe, addSubQbe, addSubQbe, addSubQbe, addWarning, addWarnings, checkMethodAccess, cleanup, clear, clearLongOpPipe, close, commit, copy, copy, copyForDM, count, deleteAll, deleteAll, deleteAndRemove, deleteAndRemove, deleteAndRemove, deleteAndRemove, deleteAndRemove, deleteAndRemoveAll, deleteAndRemoveAll, determineRequiredFieldsFromERM, earliestDate, fetchNext, findAllNullRequiredFields, findByIntegrationKey, findKey, getApp, getAppAlwaysFieldFlags, getAppWhere, getCompleteWhere, getCurrentPosition, getDBFetchMaxRows, getDefaultValue, getERMEntity, getESigTransactionId, getExcludeMeFromPropagation, getFlags, getKeyAttributes, getList, getList, getMaxMessage, getMbo, getMbo, getMboForUniqueId, getMboSetData, getMboSetData, getMboSetInfo, getMboSetRetainMboPositionData, getMboSetRetainMboPositionInfo, getMboSetValueData, getMboValueData, getMboValueData, getMboValueData, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMLFromClause, getMXTransaction, getName, getOrderBy, getOwner, getParentApp, getProfile, getQbe, getQbe, getQbe, getQbeWhere, getQueryTimeout, getRelationName, getRelationship, getSelection, getSelectionWhere, getSetOrderByForUI, getSize, getSQLOptions, getTxnPropertyMap, getUserAndQbeWhere, getUserInfo, getUserName, getUserWhere, getWarnings, getWhere, getZombie, hasMLQbe, hasQbe, hasWarnings, ignoreQbeExactMatchSet, incrementDeletedCount, init, isBasedOn, isDMDeploySet, isDMSkipFieldValidation, isDownloadSet, isEmpty, isESigNeeded, isFlagSet, isQbeCaseSensitive, isQbeExactMatch, isRetainMboPosition, latestDate, locateMbo, logESigVerification, max, min, moveFirst, moveLast, moveNext, movePrev, moveTo, newMboIndex, notExist, positionState, processML, remove, remove, remove, reset, resetQbe, resetWithSelection, rollback, rollbackToCheckpoint, rollbackToCheckpoint, save, save, select, select, select, selectAll, setAllowQualifiedRestriction, setApp, setAppAlwaysFieldFlag, setAppWhere, setAutoKeyFlag, setDBFetchMaxRows, setDefaultOrderBy, setDefaultValue, setDefaultValue, setDefaultValues, setDMDeploySet, setDMSkipFieldValidation, setDownloadSet, setERMEntity, setESigFieldModified, setExcludeMeFromPropagation, setFlag, setFlag, setFlags, setInsertCompanySet, setInsertItemSet, setInsertOrg, setInsertSite, setLastESigTransId, setLogLargFetchResultDisabled, setMXTransaction, setNoNeedtoFetchFromDB, setOrderBy, setOwner, setQbe, setQbe, setQbe, setQbe, setQbe, setQbeCaseSensitive, setQbeCaseSensitive, setQbeExactMatch, setQbeExactMatch, setQbeOperatorOr, setQueryBySiteQbe, setQueryTimeout, setRelationName, setRelationship, setRequiedFlagsFromERM, setRetainMboPosition, setSetOrderByForUI, setSQLOptions, setTableDomainLookup, setTxnPropertyMap, setupLongOpPipe, setUserWhere, setUserWhereAfterParse, setWhere, setWhereQbe, smartFill, smartFill, smartFind, smartFind, startCheckpoint, startCheckpoint, sum, undeleteAll, unselect, unselect, unselect, unselectAll, useStoredQuery, validate, verifyESig

Methods inherited from interface psdi.mbo.MboAccessInterface

getBoolean, getByte, getBytes, getDate, getDouble, getFloat, getInt, getLong, getString, isNull, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueNull, setValueNull

Methods inherited from interface psdi.txn.Transactable

commitTransaction, fireEventsAfterDB, fireEventsAfterDBCommit, fireEventsBeforeDB, rollbackTransaction, saveTransaction, undoTransaction, validateTransaction

Constructor Detail

SKDAsyncJobSubmitter

public SKDAsyncJobSubmitter(MboServerInterface ms)
                     throws java.rmi.RemoteException

Construct the set of Custom Mbos.

Parameters:

ms - The MboServerInterface CustomMboSet uses to access internals of the MXServer.

Throws:

java.rmi.RemoteException

Method Detail

getMboInstance

protected Mbo getMboInstance(MboSet ms)
                      throws MXException,
                             java.rmi.RemoteException

The derived class needs to provide the actual non-persistent object

Specified by:

getMboInstance in class AsyncJobSubmitter

Parameters:

mboset -

Throws:

MXException

java.rmi.RemoteException

getAsyncJobHandlerClassName

public java.lang.String getAsyncJobHandlerClassName()

Returns the job handler class name that will be written to the queue when job is created.

Specified by:

getAsyncJobHandlerClassName in class AsyncJobSubmitter

Returns:

handler class name

getCompleteWhereClause

public java.lang.String getCompleteWhereClause()

Get the where clause to identify one or more records of the main object that the async process is to apply on. Normally it is obtained from the owner set of the non-persistent mbo set.

Specified by:

getCompleteWhereClause in class AsyncJobSubmitter

Returns:

where clause

getObjectName

public java.lang.String getObjectName()

Returns the main object name that this async process will operate on.

Specified by:

getObjectName in class AsyncJobSubmitter

Returns:

object name

getJobName

public java.lang.String getJobName()

Get the name of the job. The name of the job should also be added into the ASYNCJOBNAME internal ALN domain.

Specified by:

getJobName in class AsyncJobSubmitter

Returns:

job name

getDescription

public java.lang.String getDescription()

Returns the description of the particular job, it is not the general description of this type of the job, it is the description that user enters to describe the particular job.

Specified by:

getDescription in class AsyncJobSubmitter

Returns:

description

isImmediate

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

Whether this job is foreground. If there is a yorn field on this non-persistent mbo that the name is "foreground", its value will be returned, otherwise false will be returned. Overwrite this method if this is not the case.

Overrides:

isImmediate in class AsyncJobSubmitter

Returns:

true if immediate else false

Throws:

MXException

java.rmi.RemoteException

getEmail

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

Gets whether email will be sent for this job. The value came from the email boolean field on the non-persistent MBO. If this is not the case, overwrite this method.

Overrides:

getEmail in class AsyncJobSubmitter

Returns:

true if email will be sent else false

Throws:

MXException

java.rmi.RemoteException

getEmailAddress

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

Gets the email address that will be sent for this job. The value came from the emailaddress ALN field on the non-persistent MBO. If this is not the case, overwrite this method.

Overrides:

getEmailAddress in class AsyncJobSubmitter

Returns:

email address

Throws:

MXException

java.rmi.RemoteException

overwriteJobDefault

public void overwriteJobDefault(MboRemote queue)
                         throws MXException,
                                java.rmi.RemoteException

Overwrite this method if you don't need to overwrite execute() but need to change the default values of the job, such as userid, locale. Set the value to the queue object.

Overrides:

overwriteJobDefault in class AsyncJobSubmitter

Parameters:

the - job mbo

Throws:

MXException

java.rmi.RemoteException

setJobName

public void setJobName(java.lang.String jobName)

Sets the Job name.

Parameters:

jobName -

setDescription

public void setDescription(java.lang.String description)

Sets the Job description.

Parameters:

description -