psdi.app.system

Class CrontaskInstance

java.lang.Object

psdi.mbo.Mbo

psdi.app.system.CrontaskInstance

All Implemented Interfaces:

java.rmi.Remote, CrontaskInstanceRemote, MboConstants, MboRemote, MaxRemoteProxy

public class CrontaskInstance
extends Mbo
implements CrontaskInstanceRemote

The MBO represent crontaskinstance. This is a system level object.

The key attribute(s) in this object are crontaskname, instancename .

The attributes in this object are as follows:

Attribute Name	Description
crontaskname	The name of the crontask.
instancename	The name of the instance.
schedule	The string to represent the crontask schedule.
reloadreqtime	The time stamp when a reload is needed.
active	Whether the instance is active. Default is not active.
description	Description of the crontask instance.

MBO for contaskdef record.

Field Summary

Fields inherited from class psdi.mbo.Mbo

MULTILANGCOPY, phantomList, phantomQueue

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

Constructor Summary

Constructors

Constructor and Description
CrontaskInstance(MboSet ms)

Method Summary

Modifier and Type	Method and Description
void	add() Add().
void	appValidate() It calls parameter validation Mbo's validate if the mbo exists for the crontask.
void	canDelete() An instance can only be removed if it is inactive.
MboRemote	copy(MboSetRemote mboset) Overwrite the copy method to copy
void	delete(long accessModifier) delete an instance will delete a
MboRemote	duplicate() Duplicate method only throws exception now
java.lang.String	getCrontaskClass()
CrontaskDefRemote	getCrontaskDef() Return the CrontaskDefRemote and also set its internal reference to the obtained CrontaskDefRemote if it hasn't been set.
java.lang.String	getId()
CrontaskParamInfo[]	getParameterList() Get the parameter information.
CrontaskParamSetRemote	getParameterSet() Get the MBO set of crontaskparam of this crontask instance.
void	init() Called by the framework when the Mbo has been constructed and the MboValues have been initialized.
void	requestReload() The action method to set the reloadreqtime timestamp.
void	requestReloadAndFirstRunNow() The action method to set the reloadreqtime timestamp and tells crontask manager to immediately run the first action of the crontask once the request is received.
protected void	save() Upon save, the request time has been modified, it will be updated to a new date that is close to the actual date of the datatase commit, and will be a little ahead to make sure the requset is picked on by the crontask manager in the next polling.
protected boolean	skipCopyField(MboValueInfo mvi) The instancename field will not be copied.
void	undelete() Unmark the Mbo for deletion.

Methods inherited from class psdi.mbo.Mbo

addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, blindCopy, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkRecordLock, checkSiteOrgAccessForSave, clear, clearRelatedSets, clearRelatedSets, commit, copy, copy, copyFake, copyValue, copyValue, createComm, delete, deleteDoclinks, determineRequiredFieldsFromERM, enableMethod, evaluateCondition, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, evaluateRestriction, excludeObjectForPropagate, findAllNullRequiredFields, fireEvent, generateAutoKey, generateContentUID, getAlwaysFlags, getAttrRestrictionFlag, getAttrRestrictions, getBoolean, getByte, getBytes, getCheckpoint, getClientLocale, getClientTimeZone, getCommLogOwnerNameAndUniqueId, getCondition, getDatabaseValue, getDate, getDeleteForInsertList, getDocLinksCount, getDomainFilterWhere, getDomainIDs, getDouble, getESId, getExistingMboSet, getFetchIndex, getFieldExceptions, getFlags, getFloat, getIgnoreLockCheck, getInitialValue, getInsertCompanySetId, getInsertItemSetId, getInsertOrganization, getInsertOrgForSite, getInsertSite, getInstanciatedMboSet, getInstanciatedMboValue, getInt, getIntegrationService, getKeyValue, getLanguageRecordRowStamp, getLinesRelationship, getList, getLockedByDisplayName, getLockedByUserID, getLong, getMatchingAttr, getMatchingAttr, getMatchingAttrs, getMaxMessage, getMboCtx, getMboData, getMboDataSet, getMboForAttribute, getMboForAttributeStatic, getMboInitialValue, getMboList, getMboLogger, getMboRecordData, getMboServer, getMboSet, getMboSet, getMboSet, getMboSetInfo, getMboSetInfo, getMboValue, getMboValueData, getMboValueData, getMboValueData, getMboValueDataForDownload, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getProfile, getPropagateKeyFlag, getProxy, getRecordIdentifer, getRecordMboName, getRecordType, getRelatedSets, getRelatedWhere, getRelatedWhere, getRelationshipNameToLangTable, getResourceName, getRowRestrictionFlag, getRowStamp, getRowStampObject, getSecurityLogger, getSiteOrg, getSqlLogger, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getSynonymValueWhere, getTenantId, getTenantIdForNoMboRecordData, getThisMboSet, getTranslator, getUniqueIdentifer, getUniqueIDName, getUniqueIDValue, getUniqueLanguageIDRecord, getUserInfo, getUserName, getValidateOrder, hasFieldAccess, hasHierarchyLink, hasLockSaveRights, hasRelatedQbe, hasUniqueID, initFieldFlagsOnMbo, initRelationship, isApiBatchError, isAppLockEnabled, isAutoKeyed, isBasedOn, isChangeByUserWhenSetFromLookup, isDuringInit, isEAuditFieldModified, isESigFieldModified, isFlagSet, isForDM, isLocked, isLocked, isLockedByMe, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNoSql, isNull, isOptionGranted, isSelected, isSkipCopyField, isValid, isZombie, lock, modify, moveFieldFlagsToMboValue, needCallInitFieldFlag, orEvaluateConditions, propagateKeyValue, removeCtx, removeRelatedSet, resolveNoSqlWhere, rollbackToCheckpoint, select, setAppDefaultValue, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDatabaseDefaultValues, setDatabaseDefaultValues, setDefaultValue, setDefaultValues, setDeleted, setDuringInit, setEAuditFieldModified, setESId, setESigFieldModified, setFetchIndex, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlags, setFlag, setFlag, setFlags, setForDM, setHierarchyLink, setIgnoreRecordLockCheck, setLangCodeDefault, setMboCtx, setMLValue, setModified, setModifiedForIntegrationOnly, setNewMbo, setNoSql, setPropagateKeyFlag, setPropagateKeyFlag, setProxy, setReadonlyWhenParentIsReadonly, setRecordType, setReferencedMbo, setReferencedMbo, setResolveNoSqlWhere, setResourceName, setTenantIdForNoMboRecordData, setUniqueIDValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueFromSequence, setValueNull, setValueNull, sigopGranted, sigopGranted, sigopGranted, sigopGranted, sigOptionAccessAuthorized, smartFill, smartFind, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, throwRequiredException, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undeleteDoclinks, unlock, unselect, useDataSecurity, validate, validateAttributes, validateKeyUniqueness, valueChanged

Methods inherited from class java.lang.Object

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

Methods inherited from interface psdi.mbo.MboRemote

addMboSetForRequiredCheck, addToDeleteForInsertList, blindCopy, checkMethodAccess, clear, copy, copy, copyFake, copyValue, copyValue, createComm, delete, 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, unlock, unselect, validate, validateAttributes

Constructor Detail

CrontaskInstance

public CrontaskInstance(MboSet ms)
                 throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

Method Detail

init

public void init()
          throws MXException

Description copied from class: Mbo

Called by the framework when the Mbo has been constructed and the MboValues have been initialized. This can be overridden by the programmer to provide any custom initialization they would like to do.

Overrides:

init in class Mbo

Throws:

MXException

getParameterList

public CrontaskParamInfo[] getParameterList()
                                     throws MXException,
                                            java.rmi.RemoteException

Get the parameter information.

Specified by:

getParameterList in interface CrontaskInstanceRemote

Returns:

an array of CrontaskParamInfo for all the parameters in this crontask.

Throws:

MXException

java.rmi.RemoteException

See Also:

CrontaskInstance.getParameterList()

getCrontaskClass

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

Specified by:

getCrontaskClass in interface CrontaskInstanceRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

psdi.app.system.CrontaskInstance#getCrontaskClassName

canDelete

public void canDelete()
               throws MXException,
                      java.rmi.RemoteException

An instance can only be removed if it is inactive.

Overrides:

canDelete in class Mbo

Throws:

MXException

java.rmi.RemoteException

delete

public void delete(long accessModifier)
            throws MXException,
                   java.rmi.RemoteException

delete an instance will delete a

Specified by:

delete in interface MboRemote

Overrides:

delete in class Mbo

Parameters:

accessModifier - The bitwise flag specified to determine if certain normal security checks are to be bypassed for this delete request. For example: if the accessModifer is NOACCESSCHECK, then the check for the object's NODELETE flag and the call to the object's canDelete() method will not be performed. If the accessModifer is NONE, then all the access checks are performed before this object is marked delete.

Throws:

MXException

java.rmi.RemoteException

See Also:

Mbo.delete(long)

undelete

public void undelete()
              throws MXException,
                     java.rmi.RemoteException

Description copied from class: Mbo

Unmark the Mbo for deletion. Can only be called after a delete() and before the save() has been performed. This method will also unmark associated Long Description and Translation Mbos.

Specified by:

undelete in interface MboRemote

Overrides:

undelete in class Mbo

Throws:

MXException

java.rmi.RemoteException

requestReload

public void requestReload()
                   throws MXException,
                          java.rmi.RemoteException

The action method to set the reloadreqtime timestamp. This method is called to notify crontask manager that this instance needs to be restarted.

Specified by:

requestReload in interface CrontaskInstanceRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

CrontaskInstance.requestReload()

requestReloadAndFirstRunNow

public void requestReloadAndFirstRunNow()
                                 throws MXException,
                                        java.rmi.RemoteException

The action method to set the reloadreqtime timestamp and tells crontask manager to immediately run the first action of the crontask once the request is received.

Specified by:

requestReloadAndFirstRunNow in interface CrontaskInstanceRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

psdi.app.syste.CrontaskInstance#requestReloadAndFirstRunNow()

save

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

Upon save, the request time has been modified, it will be updated to a new date that is close to the actual date of the datatase commit, and will be a little ahead to make sure the requset is picked on by the crontask manager in the next polling. If the NEXTRUNTMOVERWRITE time is the same as the request time, that indicates the request is to start the crontask right away, it will be set to the same time as to the new request time. If the NEXTRUNTMOVERWRITE is a future time, it will be kept if it will still be ahead of the new request time.

Overrides:

save in class Mbo

Throws:

MXException

java.rmi.RemoteException

getParameterSet

public CrontaskParamSetRemote getParameterSet()
                                       throws MXException,
                                              java.rmi.RemoteException

Get the MBO set of crontaskparam of this crontask instance. If the set is empty to startwith and there are parameters defined for the crontask, the MBOs will be added for the parameters.

Specified by:

getParameterSet in interface CrontaskInstanceRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

CrontaskInstance.getParameterSet()

add

public void add()
         throws MXException,
                java.rmi.RemoteException

Add(). Active flag will be defaulted to false, the crontask name will be set and the instance's description will be crontaskdef's description. Crontaskparameter will be added.

Specified by:

add in interface MboRemote

Overrides:

add in class Mbo

Throws:

MXException

java.rmi.RemoteException

getCrontaskDef

public CrontaskDefRemote getCrontaskDef()
                                 throws MXException,
                                        java.rmi.RemoteException

Return the CrontaskDefRemote and also set its internal reference to the obtained CrontaskDefRemote if it hasn't been set.

Specified by:

getCrontaskDef in interface CrontaskInstanceRemote

Returns:

Throws:

MXException

java.rmi.RemoteException

See Also:

psdi.app.system.CrontaskInstance#CrontaskDefRemote

appValidate

public void appValidate()
                 throws MXException,
                        java.rmi.RemoteException

It calls parameter validation Mbo's validate if the mbo exists for the crontask.

Overrides:

appValidate in class Mbo

Throws:

MXException

java.rmi.RemoteException

duplicate

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

Description copied from class: Mbo

Duplicate method only throws exception now

Specified by:

duplicate in interface MboRemote

Overrides:

duplicate in class Mbo

Throws:

MXException

java.rmi.RemoteException

copy

public MboRemote copy(MboSetRemote mboset)
               throws MXException,
                      java.rmi.RemoteException

Overwrite the copy method to copy

Specified by:

copy in interface MboRemote

Overrides:

copy in class Mbo

Parameters:

mboset - The set into which the new mbo will be added.

Returns:

The new mbo, with values copied from this mbo.

Throws:

MXException

java.rmi.RemoteException

See Also:

Mbo.copy(MboSetRemote, long)

skipCopyField

protected boolean skipCopyField(MboValueInfo mvi)
                         throws java.rmi.RemoteException,
                                MXException

The instancename field will not be copied.

Overrides:

skipCopyField in class Mbo

Throws:

java.rmi.RemoteException

MXException

getId

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

Specified by:

getId in interface CrontaskInstanceRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

CrontaskInstance.getId()