psdi.mbo

Class StatusHandler

java.lang.Object

psdi.mbo.StatusHandler

All Implemented Interfaces:

MboConstants

Direct Known Subclasses:

AMCrewStatusHandler, AMCrewTypeStatusHandler, ApptBookStatusHandler, AssetStatusHandler, AutoScriptStateHandler, BudgetStatusHandler, CdmCiTypeStatusHandler, CIStatusHandler, CommonContractStatusHandler, CountBookStatusHandler, DMPkgDefStatusHandler, FeatureStatusHandler, InspectionFormStatusHandler, InspectionResultStatusHandler, InvoiceStatusHandler, InvPickListStatusHandler, InvStatusHandler, InvUseStatusHandler, ItemOrgStatusHandler, ItemStatusHandler, JPStatusHandler, LaborQualStatusHandler, LaborStatusHandler, LocationStatusHandler, MaxIntErrorStatusHandler, MaxLicStatusHandler, MaxUserStatusHandler, MRStatusHandler, PersonStatusHandler, PkgStatusHandler, PlusCAssetTemplateStatusHandler, PlusCDSStatusHandler, PMStatusHandler, POStatusHandler, ProductStatusHandler, PRStatusHandler, QualStatusHandler, RFQStatusHandler, SKDProjectStatusHandler, SLAStatusHandler, SolutionStatusHandler, TemplateStatusHandler, TenantStatusHandler, TKStatusHandler, TokenLicStatusHandler, WOStatusHandler

public abstract class StatusHandler
extends java.lang.Object
implements MboConstants

Handles all status changes. This is instanciated automatically by a StatefulMbo object. The actual implementation of method changes is provided inside the changeStatus() method. There are various other methods that are provided to handle changing the state of a mbo based on a status and stopping access to changing a status.

Field Summary

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
StatusHandler(StatefulMbo sm) Constructor

Method Summary

Modifier and Type	Method and Description
void	canChangeStatus(java.lang.String currentStatus, java.lang.String desiredStatus, long accessModifier) Can a certain status change be performed ?
void	changeStatus(java.lang.String currentStatus, java.lang.String desiredStatus, java.util.Date date, java.lang.String memo) Change the status from the specified state to a desired state It is up to the programmer to throw and exception from this rountine if the specified status does not exist !
abstract void	checkStatusChangeAuthorization(java.lang.String desiredStatus) Is a certain status change allowable? This test determines whether a status change is possible by only checking security.
void	postStatusChange(java.lang.String currentStatus, java.lang.String status, java.util.Date asOfDate, java.lang.String memo) Object can over override this method to process post status change logic.
void	preStatusChange(java.lang.String currentStatus, java.lang.String status, java.util.Date asOfDate, java.lang.String memo) Object can over override this method to process pre status change logic.
java.lang.String	statusToOptionName(java.lang.String status) Return the sigoption associated with the status.
void	updateMboForStatus(java.lang.String status) Called to set the state of the Mbo for the specified status.

Methods inherited from class java.lang.Object

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

Constructor Detail

StatusHandler

public StatusHandler(StatefulMbo sm)

Constructor

Method Detail

changeStatus

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

Change the status from the specified state to a desired state It is up to the programmer to throw and exception from this rountine if the specified status does not exist !

Throws:

MXException

java.rmi.RemoteException

canChangeStatus

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

Can a certain status change be performed ?

Throws:

MXException

java.rmi.RemoteException

updateMboForStatus

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

Called to set the state of the Mbo for the specified status. Example would be make the Work Plan read only for an approved Work Order. BE CAREFUL ABOUT DOING EXPENSIVE OPERATIONS IN THIS METHOD !

Throws:

MXException

java.rmi.RemoteException

checkStatusChangeAuthorization

public abstract void checkStatusChangeAuthorization(java.lang.String desiredStatus)
                                             throws MXException,
                                                    java.rmi.RemoteException

Is a certain status change allowable? This test determines whether a status change is possible by only checking security.

Throws:

MXException

java.rmi.RemoteException

See Also:

This method is used to build the list of permitted status changes.

preStatusChange

public void preStatusChange(java.lang.String currentStatus,
                            java.lang.String status,
                            java.util.Date asOfDate,
                            java.lang.String memo)
                     throws MXException,
                            java.rmi.RemoteException

Object can over override this method to process pre status change logic. called by statefulmbo

Throws:

MXException

java.rmi.RemoteException

postStatusChange

public void postStatusChange(java.lang.String currentStatus,
                             java.lang.String status,
                             java.util.Date asOfDate,
                             java.lang.String memo)
                      throws MXException,
                             java.rmi.RemoteException

Object can over override this method to process post status change logic. called by statefulmbo

Throws:

MXException

java.rmi.RemoteException

statusToOptionName

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

Return the sigoption associated with the status. Call the app specific getOptionName() first, if that fails assume the option name is the same as the internal status.

Parameters:

status - The external status value

Returns: