psdi.mbo

Class StatefulMbo

java.lang.Object

psdi.mbo.Mbo

psdi.mbo.StatefulMbo

All Implemented Interfaces:

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

Direct Known Subclasses:

AMCrew, AMCrewType, ApptBook, Asset, AutoScript, BIMProductBase, Budget, CdmCiType, CI, CountBook, DMPackage, DMPackageDef, Feature, InspectionForm, InspectionResult, Inventory, Invoice, InvPickList, InvUse, Item, ItemOrgInfo, JobPlan, Labor, LaborQual, Location, MaxIntError, MaxLicense, MaxUser, MR, Person, PlusCAssetTemplate, PlusCDS, PM, PurchasingMbo, Qual, RFQ, SKDProject, SLA, Solution, TenantReg, Ticket, TKTemplate, TokenLicense, WO

public abstract class StatefulMbo
extends Mbo
implements StatefulMboRemote

Base class that represents the behaviour of a Mbo that can be in one of many statuses. Examples of these are Work Order, PR, PO, etc.

This class provides the standard features of maintaining a status history and providing statndard methods for changing the status of the object.

The actual implementation of the status change functionality, which is application specific, is implemented in a class derived from StatusHandler.

In order to make use of this class, the following assumptions are made about the Mbo.

1. The Mbo has the attributes STATUS and STATUSDATE.
2. The programmer must override the getStatusHandler(), getStatusListName() and getStatusHistory() methods.
3. The list of status must be a synonym value list.
4. The status history object must have an attribute named MEMO.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	onListTab This is the indicator on List tab
java.lang.String	statusChangeButtonSigoption This is the status change button sigoption
java.lang.String	targetStatusOption This is the status we are planning to change to

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
StatefulMbo(MboSet ms) Construct the Mbo

Method Summary

Modifier and Type	Method and Description
void	canChangeMaxStatus(java.lang.String internalStatus) Calls the canChangeStatus method with the flag set to NONE.
void	canChangeStatus(java.lang.String status) Calls the canChangeStatus method with the flag set to NONE.
void	canChangeStatus(java.lang.String changeToStatus, long accessModifier) Identifies whether the status of this object be changed to the specified value.
void	canChangeStatus(java.lang.String changeToStatus, java.lang.String progressStatus, long accessModifier) Identifies whether the status of this object be changed to the specified value.
void	canDeleteAttachedDocs() Check if the attached document can be deleted.
void	changeMaxStatus(java.lang.String internalStatus, java.util.Date date, java.lang.String memo) Changes the status with an internal maximo status value.
void	changeMaxStatus(java.lang.String internalStatus, java.util.Date date, java.lang.String memo, long accessModifier) Changes the status with an internal maximo status value.
void	changeStatus(java.lang.String status, java.util.Date date, java.lang.String memo) Calls the changeStatus method with an accessModifier of NONE.
void	changeStatus(java.lang.String status, java.util.Date asOfDate, java.lang.String memo, long accessModifier) Changes the status of the object.
void	changeStatus(java.lang.String status, java.lang.String progressStatus, java.util.Date asOfDate, java.lang.String memo, long accessModifier) Changes the status of the object.
void	checkForOpenStatus() Checks to see if it is a History record.
void	checkStatusChangeAuthorization(java.lang.String changeToStatus, boolean single) Determines if it is possible for this work order to change to this status.
void	filterByValidStatusList(boolean onlyCanBeChanged, MboSetRemote values)
void	fireEvent(java.lang.String type) fires events for the different types of events for all status changes.
java.lang.String	getInternalStatus() Returns the Internal value for the current status of the object.
boolean	getOnListTab() get the onListTab.
boolean	getOverridePVStatusException() get the overridePVStatusException.
java.lang.String	getStatusChangeButtonSigoption() get the targetStatusOption.
protected abstract StatusHandler	getStatusHandler() Return the status handler object to be used for the actual changing of the status.
protected abstract MboSetRemote	getStatusHistory() Return the MboSet object used for storing the status change history.
MboSetRemote	getStatusList() Returns a remote reference to a ValueList MboSet representing the possibly valid status codes that the logged-in user is permitted to use.
abstract java.lang.String	getStatusListName() Return the name of the value list which contains the list of status's.
java.lang.String	getTargetStatusOption() get the targetStatusOption.
MboSetRemote	getValidStatusList() Get the list of those statuses that the current record is allowed to changed to from the current status.
protected void	save() Overrides the save of Mbo so that a row is added to the status history table when a new object is saved.
void	setOnListTab(boolean onListTab) set the onListTab.
void	setOverridePVStatusException(boolean overridePVStatusException) get the overridePVStatusException.
void	setStatusChangeButtonSigoption(java.lang.String statusChangeButtonSigoption) set the targetStatusOption.
void	setTargetStatusOption(java.lang.String targetStatusOption) set the targetStatusOption.
java.lang.String	statusToOptionName(java.lang.String status) Return the sigoption name for the status.

Methods inherited from class psdi.mbo.Mbo

add, addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, appValidate, blindCopy, canDelete, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkRecordLock, checkSiteOrgAccessForSave, clear, clearRelatedSets, clearRelatedSets, commit, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, delete, deleteDoclinks, determineRequiredFieldsFromERM, duplicate, enableMethod, evaluateCondition, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, evaluateRestriction, excludeObjectForPropagate, findAllNullRequiredFields, 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, init, 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, skipCopyField, smartFill, smartFind, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, throwRequiredException, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, 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

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

Field Detail

targetStatusOption

public java.lang.String targetStatusOption

This is the status we are planning to change to

onListTab

public boolean onListTab

This is the indicator on List tab

statusChangeButtonSigoption

public java.lang.String statusChangeButtonSigoption

This is the status change button sigoption

Constructor Detail

StatefulMbo

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

Construct the Mbo

Throws:

java.rmi.RemoteException

Method Detail

getStatusHandler

protected abstract StatusHandler getStatusHandler()

Return the status handler object to be used for the actual changing of the status. This is only called once by the framework. This method must be provided by the Mbo programmer.

getStatusHistory

protected abstract MboSetRemote getStatusHistory()
                                          throws MXException,
                                                 java.rmi.RemoteException

Return the MboSet object used for storing the status change history. This method must be provided by the Mbo programmer.

Throws:

MXException

java.rmi.RemoteException

getInternalStatus

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

Returns the Internal value for the current status of the object.

Specified by:

getInternalStatus in interface StatefulMboRemote

Throws:

MXException

java.rmi.RemoteException

changeMaxStatus

public void changeMaxStatus(java.lang.String internalStatus,
                            java.util.Date date,
                            java.lang.String memo,
                            long accessModifier)
                     throws MXException,
                            java.rmi.RemoteException

Changes the status with an internal maximo status value.

Specified by:

changeMaxStatus in interface StatefulMboRemote

Parameters:

status - The new desired status. This is the non-translated status, the internal status value (valuelist.maxvalue).

date - The effective date of the new status (java.util.Date).

memo - A string briefly describing the circumstances of the change. The memo can be null.

Throws:

MXException - Thrown if there is a problem, or the status cannot be changed, as determined by canChangeStatus(String).

java.rmi.RemoteException

See Also:

StatefulMbo.changeStatus(String,java.util.Date,String,long)

changeMaxStatus

public void changeMaxStatus(java.lang.String internalStatus,
                            java.util.Date date,
                            java.lang.String memo)
                     throws MXException,
                            java.rmi.RemoteException

Changes the status with an internal maximo status value.

Specified by:

changeMaxStatus in interface StatefulMboRemote

Parameters:

status - The new desired status. This is the non-translated status, the internal status value (valuelist.maxvalue).

date - The effective date of the new status (java.util.Date).

memo - A string briefly describing the circumstances of the change. The memo can be null.

Throws:

MXException - Thrown if there is a problem, or the status cannot be changed, as determined by canChangeStatus(String).

java.rmi.RemoteException

See Also:

StatefulMbo.changeStatus(String,java.util.Date,String,long)

changeStatus

public void changeStatus(java.lang.String status,
                         java.util.Date date,
                         java.lang.String memo)
                  throws MXException,
                         java.rmi.RemoteException

Calls the changeStatus method with an accessModifier of NONE.

Specified by:

changeStatus in interface StatefulMboRemote

Parameters:

status - The new desired status. This is the translated status (that is, the status code as it would have been entered by a user, or valuelist.value), not the internal status value (valuelist.maxvalue).

date - The effective date of the new status (java.util.Date).

memo - A string briefly describing the circumstances of the change. The memo can be null.

Throws:

MXException - Thrown if there is a problem, or the status cannot be changed, as determined by canChangeStatus(String).

java.rmi.RemoteException

See Also:

StatefulMbo.changeStatus(String,java.util.Date,String,long)

changeStatus

public void changeStatus(java.lang.String status,
                         java.util.Date asOfDate,
                         java.lang.String memo,
                         long accessModifier)
                  throws MXException,
                         java.rmi.RemoteException

Changes the status of the object. This method compares the requested status and the current status by calling canChangeStatus before the change is performed. If the status change is allowed, the status change is performed and a status history record is written. If the status change is not allowed, an exception is thrown.

If the new status has the same MaxValue as the current status, then only the status and statusDate attributes are updated, and the StatusHandler is not used.

Specified by:

changeStatus in interface StatefulMboRemote

Parameters:

status - The new desired status. This is the translated status (that is, the status code as it would have been entered by a user, or valuelist.value), not the internal status value (valuelist.maxvalue).

asOfDate - The effective date of the new status (java.util.Date). If this value is null, the current date/time of the server will be used.

memo - A string briefly describing the circumstances of the change. The memo can be null.

accessModifier - A value of NOACCESSCHECK will cause the method not to call canChangeStatus. Callers using this flag are responsible for ensuring that they are attempting a valid status change.

Throws:

MXException - Thrown if there is a problem, or the status cannot be changed, as determined by canChangeStatus(String).

java.rmi.RemoteException

See Also:

StatefulMbo.canChangeStatus(String)

changeStatus

public void changeStatus(java.lang.String status,
                         java.lang.String progressStatus,
                         java.util.Date asOfDate,
                         java.lang.String memo,
                         long accessModifier)
                  throws MXException,
                         java.rmi.RemoteException

Changes the status of the object. The difference from previous method is this method takes another status value progressstatus. Progressstatus is not a real status. But if progreestatus changes it inserts a value in status table.

Specified by:

changeStatus in interface StatefulMboRemote

Parameters:

status - Target status

progressStatus - Just a new status string in status table

asOfDate - The effective date of the new statusThe effective date of the new status

memo - A string briefly describing the circumstances of the change

accessModifier - he bitwise flags such as NOACCESSCHECK, NOVALIDATION_AND_NOACTION, and DELAYVALIDATION.

Throws:

MXException

java.rmi.RemoteException

See Also:

* @param status

canChangeStatus

public void canChangeStatus(java.lang.String changeToStatus,
                            java.lang.String progressStatus,
                            long accessModifier)
                     throws MXException,
                            java.rmi.RemoteException

Identifies whether the status of this object be changed to the specified value. If status change is not allowed, an exception is thrown. Status changes to same status as the current status are denied if progressstatus is same. else we allow to cjhange status so that a new row will be created in status table for progressstatus.Status changes to another synonym of the current status's MaxValue are always allowed.

Specified by:

canChangeStatus in interface StatefulMboRemote

Parameters:

changeToStatus - The new desired status. This is the translated status (that is, the status code as it would have been entered by a user, or valuelist.value), not the internal status value (valuelist.maxvalue).

progressStatus - sub status progressStatus for a status

accessModifier - If set to NOACCESSCHECK, allows status changes when not normally allowed.

Throws:

MXException - Thrown if the status cannot be changed.

java.rmi.RemoteException

See Also:

StatefulMbo.canChangeStatus(String changeToStatus,String progressStatus, long accessModifier)

checkStatusChangeAuthorization

public void checkStatusChangeAuthorization(java.lang.String changeToStatus,
                                           boolean single)
                                    throws MXException,
                                           java.rmi.RemoteException

Determines if it is possible for this work order to change to this status. Only security and the current status of the work order are looked at. This method throws an exception if the status change is not allowable.

Parameters:

changeToStatus - The new desired status. This is the translated status (that is, the status code as it would have been entered by a user, or valuelist.value), not the internal status value (valuelist.maxvalue).

Throws:

Can - throw access exception with key "samestatus" or "UnrecogStatus".

MXException

java.rmi.RemoteException

See Also:

This method is called to create the list returned by getStatusList.

canChangeMaxStatus

public void canChangeMaxStatus(java.lang.String internalStatus)
                        throws MXException,
                               java.rmi.RemoteException

Calls the canChangeStatus method with the flag set to NONE.

Specified by:

canChangeMaxStatus in interface StatefulMboRemote

Parameters:

status - The new desired status. This is the the internal status value (valuelist.maxvalue).

Throws:

MXException

java.rmi.RemoteException

See Also:

StatefulMbo.canChangeStatus(String, long)

canChangeStatus

public void canChangeStatus(java.lang.String status)
                     throws MXException,
                            java.rmi.RemoteException

Calls the canChangeStatus method with the flag set to NONE.

Specified by:

canChangeStatus in interface StatefulMboRemote

Parameters:

status - The new desired status. This is the translated status (that is, the status code as it would have been entered by a user, or valuelist.value), not the internal status value (valuelist.maxvalue).

Throws:

MXException

java.rmi.RemoteException

See Also:

StatefulMbo.canChangeStatus(String, long)

canChangeStatus

public void canChangeStatus(java.lang.String changeToStatus,
                            long accessModifier)
                     throws MXException,
                            java.rmi.RemoteException

Identifies whether the status of this object be changed to the specified value. If status change is not allowed, an exception is thrown. Status changes to same status as the current status are denied. Status changes to another synonym of the current status's MaxValue are always allowed.

Parameters:

changeToStatus - The new desired status. This is the translated status (that is, the status code as it would have been entered by a user, or valuelist.value), not the internal status value (valuelist.maxvalue).

accessModifier - If set to NOACCESSCHECK, allows status changes when not normally allowed.

Throws:

MXException - Thrown if the status cannot be changed.

java.rmi.RemoteException

save

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

Overrides the save of Mbo so that a row is added to the status history table when a new object is saved.

Overrides:

save in class Mbo

Throws:

MXException

java.rmi.RemoteException

getStatusListName

public abstract java.lang.String getStatusListName()

Return the name of the value list which contains the list of status's. This MUST be overridden by the Mbo programmer.

Specified by:

getStatusListName in interface StatefulMboRemote

getStatusList

public MboSetRemote getStatusList()
                           throws MXException,
                                  java.rmi.RemoteException

Returns a remote reference to a ValueList MboSet representing the possibly valid status codes that the logged-in user is permitted to use. This list is created with out reference to any particular StatefulMbo. A status must be possible as determined by checkStatusChangeAuthorization in order to be included in the set.

Specified by:

getStatusList in interface StatefulMboRemote

Returns:

The MboSetRemote of ValueList containing the allowable new status codes.

Throws:

MXException

java.rmi.RemoteException

See Also:

Used to create the list. This method only checks user privileges and rules not involving details of the object changing status. The method canChangeStatus can reject some of the members of this list.

getValidStatusList

public MboSetRemote getValidStatusList()
                                throws MXException,
                                       java.rmi.RemoteException

Get the list of those statuses that the current record is allowed to changed to from the current status. If no status can be changed from the current status, an empty MBO set will be returned.

Specified by:

getValidStatusList in interface StatefulMboRemote

Returns:

Throws:

MXException

java.rmi.RemoteException

filterByValidStatusList

public void filterByValidStatusList(boolean onlyCanBeChanged,
                                    MboSetRemote values)
                             throws MXException,
                                    java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

fireEvent

public void fireEvent(java.lang.String type)
               throws MXException,
                      java.rmi.RemoteException

fires events for the different types of events for all status changes. The possible different types are - validate, preSaveEventAction, eventAction, postCommitEventAction

Overrides:

fireEvent in class Mbo

Throws:

MXException

java.rmi.RemoteException

checkForOpenStatus

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

Checks to see if it is a History record. If the record's history flag is true, throws an exception.

Specified by:

checkForOpenStatus in interface StatefulMboRemote

Throws:

MXApplicationException - (system, ishistory) is thrown if the record is history

MXException

java.rmi.RemoteException

See Also:

StatefulMbo.checkForOpenStatus()

getOverridePVStatusException

public boolean getOverridePVStatusException()
                                     throws java.rmi.RemoteException

get the overridePVStatusException.

Specified by:

getOverridePVStatusException in interface StatefulMboRemote

Throws:

java.rmi.RemoteException

See Also:

StatefulMbo.getOverridePVStatusException()

setOverridePVStatusException

public void setOverridePVStatusException(boolean overridePVStatusException)
                                  throws java.rmi.RemoteException

get the overridePVStatusException.

Specified by:

setOverridePVStatusException in interface StatefulMboRemote

Throws:

java.rmi.RemoteException

See Also:

StatefulMbo.setOverridePVStatusException(boolean)

canDeleteAttachedDocs

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

Check if the attached document can be deleted. Throw exception if it cannot

Specified by:

canDeleteAttachedDocs in interface StatefulMboRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

StatefulMbo.canDeleteAttachedDocs()

setTargetStatusOption

public void setTargetStatusOption(java.lang.String targetStatusOption)
                           throws java.rmi.RemoteException

set the targetStatusOption.

Specified by:

setTargetStatusOption in interface StatefulMboRemote

Throws:

java.rmi.RemoteException

See Also:

StatefulMbo.setTargetStatusOption(String targetStatusOption)

getTargetStatusOption

public java.lang.String getTargetStatusOption()
                                       throws java.rmi.RemoteException

get the targetStatusOption.

Specified by:

getTargetStatusOption in interface StatefulMboRemote

Returns:

Throws:

java.rmi.RemoteException

See Also:

StatefulMbo.getTargetStatusOption()

setOnListTab

public void setOnListTab(boolean onListTab)
                  throws java.rmi.RemoteException

set the onListTab.

Specified by:

setOnListTab in interface StatefulMboRemote

Throws:

java.rmi.RemoteException

See Also:

StatefulMbo.setOnListTab(boolean onListTab)

getOnListTab

public boolean getOnListTab()
                     throws java.rmi.RemoteException

get the onListTab.

Specified by:

getOnListTab in interface StatefulMboRemote

Returns:

Throws:

java.rmi.RemoteException

See Also:

StatefulMbo.getOnListTab()

setStatusChangeButtonSigoption

public void setStatusChangeButtonSigoption(java.lang.String statusChangeButtonSigoption)
                                    throws java.rmi.RemoteException

set the targetStatusOption.

Specified by:

setStatusChangeButtonSigoption in interface StatefulMboRemote

Throws:

java.rmi.RemoteException

See Also:

StatefulMbo.setStatusChangeButtonSigoption(String statusChangeButtonSigoption)

getStatusChangeButtonSigoption

public java.lang.String getStatusChangeButtonSigoption()
                                                throws java.rmi.RemoteException

get the targetStatusOption.

Specified by:

getStatusChangeButtonSigoption in interface StatefulMboRemote

Returns:

Throws:

java.rmi.RemoteException

See Also:

StatefulMbo.getStatusChangeButtonSigoption()

statusToOptionName

public java.lang.String statusToOptionName(java.lang.String status)

Return the sigoption name for the status.

Parameters:

status - The external status

Returns: