psdi.app.workorder

Class WPTool

java.lang.Object

psdi.mbo.Mbo

psdi.app.workorder.WPItem

psdi.app.workorder.WPTool

All Implemented Interfaces:

java.rmi.Remote, WorkPlanMbo, WPItemRemote, WPToolRemote, MboConstants, MboRemote, MaxRemoteProxy

public class WPTool
extends WPItem
implements WPToolRemote

MBO to represent a WPTool object.

See WorkOrder Package description for detail.

There is no key attribute for this object.

The attributes in this object are as follows:

Attribute Name	Description
CatalogCode	See WPItem for details.
Description	See WPItem for details.
DirectReq	See WPItem for details.
IssueTo	See WPItem for details.
LineType	The line type of work plan tools.
LdKey	LineCost	A non-persistent attribute to calculate the total cost of the line(ToolHrs*ToolQty*Rate).
Location	Primary or alternate location from inventory for this work plan material/service/tool item.
Manufacturer	See WPItem for details.
ModelNum	See WPItem for details.
PR}	See WPItem for details.
PRLineNum	See WPItem for details.
RequestBy	See WPItem for details.
RequireDate	See WPItem for details.
SiteId	Identifier of the site for this failure.
OrderUnit	See WPItem
OrgId	Identifier of the organization for this failure.
Rate	Tool Rate when work order was approved.
RateHasChanged	Flag tracks if the tool rate has been overwritten by user. If No - field will be overwritten by MAXIMO on Approval. If Yes - field will not be overwritten by MAXIMO on Approval.
SiteId	Identifier of the site for this failure.
TaskID	A non-persistent attribute to identify the task number of the Work Order associate with this work plan tool.
Hours	Number of hours for which a tool is used.
ItemNum	Identification number of Tool for this work plan tool.
ItemQty	Quantity of the tool for this Work Plan.
WoNum	Identifier of the workorder associate with this work plan tool.
Vendor	See WPItem for details.
VendorPackCode	See WPItem for details.
VendorPackQuantity	See WPItem for details.
VendorUnitPrice	See WPItem for details.
VendorWareHouse	See WPItem for details.

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
WPTool(MboSet ms) Construct the WPTool.

Method Summary

Modifier and Type	Method and Description
void	add() Sets Default value for some of the fields of the new WPTool.
void	appValidate() validates WPTool.
void	canDelete() Can not delete if there exists an Actual Tool for this WPTool.
void	copyPlan(MboRemote source) Used to fill in data when copying from Job Tool.
void	delete(long accessModifier) Subtracts the line cost from WO.EstToolCost.
MboRemote	getAssociatedLabor()
void	init() Initialize the WPTool object.
boolean	isCrewTool()
void	refreshRate() If ratehaschanged is false, copy tool.toolrate to wptool.rate.
void	removeTool()
void	setFieldsFlagInDuplicate() Set fields read only or editable based on the Reservereq.
protected boolean	skipCopyField(MboValueInfo mvi) Overrides the skipCopyField() in the Mbo.
void	undelete() Adds the line cost to WO.EstMatCost.
void	updateEstimateTotal(double delta) Used to update WO.EstToolCost when the Quantity, Rate, or Hours changes on a WPTool.
void	updateTotals(MboRemote wo, boolean isGain) Updates the work order totals related to the work plan mbo.
void	validateToolAvailInStorerooms() Checks to see whether this tool is available in any of the storerooms for a given storeroom's site

Methods inherited from class psdi.app.workorder.WPItem

copyHazardForItem, getRequiredMaterialCost, getValidateOrder, isNullQty, propagateKeyValue, setBaseCurrencyUnitCost, setEstCost, setLocation, setVendor, validateStoreLocSite

Methods inherited from class psdi.mbo.Mbo

addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, blindCopy, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkRecordLock, checkSiteOrgAccessForSave, clear, clearRelatedSets, clearRelatedSets, commit, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, deleteDoclinks, determineRequiredFieldsFromERM, duplicate, 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, 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, removeCtx, removeRelatedSet, resolveNoSqlWhere, rollbackToCheckpoint, save, 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, copy, copyFake, copyValue, copyValue, createComm, 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, unlock, unselect, validate, validateAttributes

Constructor Detail

WPTool

public WPTool(MboSet ms)
       throws MXException,
              java.rmi.RemoteException

Construct the WPTool.

Parameters:

ms - The WPTool MboSet.

Throws:

MXException

java.rmi.RemoteException

Method Detail

init

public void init()
          throws MXException

Initialize the WPTool object. owner must be workorder

Overrides:

init in class Mbo

Throws:

MXApplicationException - ownerWoWPTool when its owner is not Workorder.

MXException

add

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

Sets Default value for some of the fields of the new WPTool. New WPTool can be created by the object that is based on Workorder.

WONUM defaults from the parent and set WONUM of parent to read only.
The table below shows the default values for each of the attributes listed.

Attribute Name	Attribute Value
LINECOST	0.0
Hours	0.0
Linetype	TOOL
StoreLocSite	Owner's SiteID

Specified by:

add in interface MboRemote

Overrides:

add in class WPItem

Throws:

MXApplicationException - ownerWoWPLabor when this wptool's owner is not a workorder.

MXException

java.rmi.RemoteException

appValidate

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

validates WPTool. If the Reservation required is true, then location and storeroom's site are needed

Overrides:

appValidate in class Mbo

Throws:

MXApplicationException - ("workorder", "NeedStoreroom") is thrown when the Reservereq is true.

MXException

java.rmi.RemoteException

canDelete

public void canDelete()
               throws MXException

Can not delete if there exists an Actual Tool for this WPTool.

Overrides:

canDelete in class Mbo

Throws:

MXAccessException - deletewptool when there exists an Actual tool for this WPTOOL

MXException

refreshRate

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

If ratehaschanged is false, copy tool.toolrate to wptool.rate.

Throws:

MXException

java.rmi.RemoteException

copyPlan

public void copyPlan(MboRemote source)
              throws MXException,
                     java.rmi.RemoteException

Used to fill in data when copying from Job Tool.

Specified by:

copyPlan in interface WorkPlanMbo

Overrides:

copyPlan in class WPItem

Parameters:

source - the job tool Mbo used to copy data from.

Throws:

MXException

java.rmi.RemoteException

See Also:

WPItem.getRequiredMaterialCost(), #getItemCostFromInventory, WPItem.copyHazardForItem()

updateEstimateTotal

public void updateEstimateTotal(double delta)
                         throws MXException,
                                java.rmi.RemoteException

Used to update WO.EstToolCost when the Quantity, Rate, or Hours changes on a WPTool. Called by those attribute's custom classes action methods.

Parameters:

delta - The change in toolcost need be added to WO.EstToolCost.

Throws:

MXException

java.rmi.RemoteException

validateToolAvailInStorerooms

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

Checks to see whether this tool is available in any of the storerooms for a given storeroom's site

Throws:

MXException

java.rmi.RemoteException

delete

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

Subtracts the line cost from WO.EstToolCost. WO.EstToolCost becomes editable when the last WPTool is deleted from the set.

Specified by:

delete in interface MboRemote

Overrides:

delete in class Mbo

Parameters:

accessModifier -

Throws:

MXException

java.rmi.RemoteException

See Also:

Mbo.delete(long)

undelete

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

Adds the line cost to WO.EstMatCost. If WO.EstMatCost is zero'ed out and becomes read/only when the number of WPTool objects go from none to one.

Specified by:

undelete in interface MboRemote

Overrides:

undelete in class Mbo

Throws:

MXException

java.rmi.RemoteException

updateTotals

public void updateTotals(MboRemote wo,
                         boolean isGain)
                  throws MXException,
                         java.rmi.RemoteException

Updates the work order totals related to the work plan mbo.

Specified by:

updateTotals in interface WorkPlanMbo

Overrides:

updateTotals in class WPItem

Parameters:

wo - The work order Mbo to update.

isGain - Is this a gain or loss for the work order.

Throws:

MXException

java.rmi.RemoteException

skipCopyField

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

Overrides the skipCopyField() in the Mbo. Since this method takes the MboValueInfo as its parameter just check to see if this field needs to be copied or not. If this field does not need to be copied return true. The following is a list of fields that are not copied from the source WPTool to the target WPTool.

1. WONUM
2. TOOLHRS

Overrides:

skipCopyField in class WPItem

Parameters:

The - MboValueInfo object of the MboValue that needs to be copied.

Returns:

True if the field does not need to be copied, otherwise return false.

Throws:

java.rmi.RemoteException

MXException

setFieldsFlagInDuplicate

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

Set fields read only or editable based on the Reservereq. It will be called by WO duplicate method.

Specified by:

setFieldsFlagInDuplicate in interface WPToolRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

WPTool.setFieldsFlagInDuplicate()

isCrewTool

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

Specified by:

isCrewTool in interface WPToolRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

WPTool.isCrewTool()

getAssociatedLabor

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

Specified by:

getAssociatedLabor in interface WPToolRemote

Throws:

java.rmi.RemoteException

MXException

See Also:

WPTool.getAssociatedLabor()

removeTool

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

Specified by:

removeTool in interface WPToolRemote

Throws:

MXException

java.rmi.RemoteException