psdi.app.workorder

Class WOService

java.lang.Object

psdi.server.AppService

psdi.app.workorder.WOService

All Implemented Interfaces:

java.rmi.Remote, WOServiceRemote, MboServerInterface, MaxRemoteProxy, AppServiceRemote, Dependable, Service, ServiceRemote, FixedLoggerNames, FixedLoggers

public class WOService
extends AppService
implements WOServiceRemote

The workorder service object.

Author:

John Neville

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAXPRIORITY The maximum priority value.

Fields inherited from interface psdi.app.workorder.WOServiceRemote

critAPPROVED, critAPPROVEDCHARGES, critHISTORY, critINCOMPLETE, critINCOMPLETECHARGES, critNOTCANCELLED, critNOTCOMPLETE, critOPEN, critOPENCHARGES, critUNAPPROVED

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
WOService() constructor for WOService.
WOService(MXServer mxServer) constructor for WOService.

Method Summary

Methods

Modifier and Type	Method and Description
void	calculateResponseDate(WO forWO) Calculates the response time given the value of the CalcPriority attribute.
void	calculateWorkPriority(MboRemote forWO, UserInfo ui) Calculates the value for the CalcPriority attribute, given the current values of WoPriority and AssetLocPriority and the select priority formula.
void	changeStatus(WORemote wo, java.lang.String status, java.util.Date date, java.lang.String memo) Service Method used to change status.
void	destroy() Unregister event listeners.
Assignment	getAssingment(java.lang.String assignmentid, UserInfo userInfo)
WoEditSettings	getEditSettings(WO forWO) Gets the edit settings for the status the workorder is at and its site.
WoEditSettings	getISCalEditSettings(WO wo) Gets the checks if is cal edit settings.
Labor	getLaborCode(UserInfo userInfo)
boolean	getWorkTypeAttribute(WO forWO, java.lang.String attr) Determines the value for this workorder's worktype attribute.
void	init() Initialization
void	initCriteriaList(java.util.Hashtable criteriaTable) Criteria defined for the WOService object: OPEN - all open work orders.
void	restart() Indicates that the Service should reload any cached information.
boolean	tagoutsMustBelongToHazards() Identify whether tagouts must belong to hazards.
void	updateWoForMovedAsset(MboRemote movedAsset) Updates the workorders which reference a piece of asset which has moved.

Methods inherited from class psdi.server.AppService

checkSecurity, configure, freeDBConnection, freeMboSet, getCriteria, getCurrentState, getDBConnection, getLiveObjCount, getLoad, getMaximoDD, getMaxVar, getMboSet, getMXServer, getName, getProfile, getProxy, getSchemaOwner, getServiceInfo, getServiceLogger, getSetForRelationship, getSetFromKeys, getStateCmdList, getStateList, getURL, isAppService, isRunning, isSingletonService, setProxy, setRunning, setURL, verifyUser, verifyUser

Methods inherited from class java.lang.Object

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

Methods inherited from interface psdi.server.AppServiceRemote

checkSecurity, getCriteria, getCurrentState, getLiveObjCount, getMboSet, getName, getSchemaOwner, getSetForRelationship, getSetFromKeys, getStateCmdList, getStateList, getURL, verifyUser, verifyUser

Methods inherited from interface psdi.server.ServiceRemote

isAppService, isSingletonService

Field Detail

MAXPRIORITY

public static final int MAXPRIORITY

The maximum priority value. For attributes WoPriority, AssetLocPriority, and CalcPriority on the WO object.

See Also:

Constant Field Values

Constructor Detail

WOService

public WOService()
          throws java.rmi.RemoteException

constructor for WOService.

Throws:

java.rmi.RemoteException

WOService

public WOService(MXServer mxServer)
          throws java.rmi.RemoteException

constructor for WOService.

Parameters:

mxServer - the "Server Environment" this Service is being created in.

Throws:

java.rmi.RemoteException

Method Detail

restart

public void restart()
             throws java.rmi.RemoteException

Indicates that the Service should reload any cached information. Clears Priority and Edit Setting cached information.

Specified by:

restart in interface ServiceRemote

Overrides:

restart in class AppService

Throws:

java.rmi.RemoteException

calculateWorkPriority

public void calculateWorkPriority(MboRemote forWO,
                         UserInfo ui)
                           throws MXException,
                                  java.rmi.RemoteException

Calculates the value for the CalcPriority attribute, given the current values of WoPriority and AssetLocPriority and the select priority formula.

Specified by:

calculateWorkPriority in interface WOServiceRemote

Parameters:

forWO - the workorder which its CalcPriority need be calculated.

ui - The user info object for the user.

Throws:

MXException

java.rmi.RemoteException

calculateResponseDate

public void calculateResponseDate(WO forWO)
                           throws MXException,
                                  java.rmi.RemoteException

Calculates the response time given the value of the CalcPriority attribute. The response time is added to the report date and put into the RespondBy attribute.

Parameters:

forWO - the workorder which its RespondBy need be calculated.

Throws:

MXException

java.rmi.RemoteException

getEditSettings

public WoEditSettings getEditSettings(WO forWO)
                               throws MXException,
                                      java.rmi.RemoteException

Gets the edit settings for the status the workorder is at and its site. The WO object uses the settings to set read-only flags.

Parameters:

forWO - The workorder to get edit settings for.

Throws:

MXException

java.rmi.RemoteException

getWorkTypeAttribute

public boolean getWorkTypeAttribute(WO forWO,
                           java.lang.String attr)
                             throws MXException,
                                    java.rmi.RemoteException

Determines the value for this workorder's worktype attribute. If the work order's work type is not found, false is returned.

Parameters:

forWO - The work order needing work type information

attr - The work type attribute desired. Either "PromptFail" or "PromptDown" for now.

Returns:

The value of the WO's work type attribute.

Throws:

MXException

java.rmi.RemoteException

updateWoForMovedAsset

public void updateWoForMovedAsset(MboRemote movedAsset)
                           throws MXException,
                                  java.rmi.RemoteException

Updates the workorders which reference a piece of asset which has moved. Asset is assumed to be moved before calling this method.

Specified by:

updateWoForMovedAsset in interface WOServiceRemote

Parameters:

movedAsset - the asset Mbo which has moved.

Throws:

MXException

java.rmi.RemoteException

initCriteriaList

public void initCriteriaList(java.util.Hashtable criteriaTable)
                      throws MXException,
                             java.rmi.RemoteException

Criteria defined for the WOService object: OPEN - all open work orders. OPENCHARGES - all open and accept charges work orders. HISTORY - all closed and cancelled work orders. APPROVED - Open work orders which not waiting for approval. APPROVEDCHARGES - Open and accept charges work orders which not waiting for approval. UNAPPROVED - Waiting for approval work orders. INCOMPLETE - Open and approved work orders which aren't complete. INCOMPLETECHARGES - Open and approved and accept charges work orders which aren't complete. NOTCANCELLED - Appoved work orders which have not been cancelled. NOTCOMPLETE - Open work orders which are not complete either.

Overrides:

initCriteriaList in class AppService

Parameters:

criteriaTable - the Hashtable to store Criterias.

Throws:

MXException

java.rmi.RemoteException

tagoutsMustBelongToHazards

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

Identify whether tagouts must belong to hazards. If true, then all wotagout throughout the system must belong to wohazard. If false, then NO wotagout anywhere in the system may belong to wohazard. This used to be identified via the maxvar TAGOUTSHAVEHAZARDS, but now always returns True.

Returns:

True if tagouts must belong to hazards, else False.

Throws:

MXException

java.rmi.RemoteException

init

public void init()

Initialization

Specified by:

init in interface Service

Overrides:

init in class AppService

See Also:

WorkOrderListener, WOStatusChangeListener

destroy

public void destroy()

Unregister event listeners.

Specified by:

destroy in interface Service

Overrides:

destroy in class AppService

See Also:

AppService.destroy()

changeStatus

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

Service Method used to change status.

Specified by:

changeStatus in interface WOServiceRemote

Parameters:

wo - Work Order Mbo

status - The new status

date - The date of the status change. Defaults to the current date/time if null.

memo - The status change memo.

Throws:

MXException("access", - "samestatus"); MXException("access", "UnrecogStatus") MXException("workorder", "unappr") MXException("workorder", "wappr") MXException("workorder", "wappr") MXException("workorder", "inprg") MXException("workorder", "comp"") MXException("workorder", "close") MXException("workorder","can") MXException("workorder","wsch") MXException("access", "notauthorized") MXException("workorder", "notcloselabtrans") MXException("workorder", "actuals") MXException("workorder", "CannotCancel") MXException("workorder", "ReqApprContractToApprWO") MXException("workorder", "processflowsuspended"); MXException("workorder", "cantcompletebeforestart") MXException("workorder", "predecessorsnotcomp") MXException("workorder", "parentnotstarted") MXException("workorder", "invalidstatus") MXException("workorder", "childrenmustbecompleted")

MXException

java.rmi.RemoteException

See Also:

throws MXException, RemoteException

getISCalEditSettings

public WoEditSettings getISCalEditSettings(WO wo)
                                    throws MXException,
                                           java.rmi.RemoteException

Gets the checks if is cal edit settings.

Parameters:

wo - the wo

Returns:

the checks if is cal edit settings

Throws:

MXException - the mX exception

java.rmi.RemoteException - the remote exception

getAssingment

public Assignment getAssingment(java.lang.String assignmentid,
                       UserInfo userInfo)
                         throws java.rmi.RemoteException,
                                MXException

Throws:

java.rmi.RemoteException

MXException

getLaborCode

public Labor getLaborCode(UserInfo userInfo)
                   throws java.rmi.RemoteException,
                          MXException

Throws:

java.rmi.RemoteException

MXException