psdi.app.workorder

Class WPMaterial

java.lang.Object

psdi.mbo.Mbo

psdi.app.workorder.WPItem

psdi.app.workorder.WPMaterial

All Implemented Interfaces:

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

public class WPMaterial
extends WPItem
implements WPMaterialRemote

Mbo to Represent the WPMaterial Object. WPMaterial is a view which extend from WPItem.

See WorkOrder Package description.

There is no key attribute for this object. The attributes in this object are as follows:

Attribute Name	Description
CatalogCode	The Catalog code for the item, or the vendor part number.
Description	The Description for the item on this reservation.
DirectReq	This is to signify if the item on this reservation will be ordered outside of standard inventory.
IssueTo	Issue to a laborcode or craft.
ItemNum	Identifier of the Item for this wpmaterial.
ItemQty	Item quantity required for the work plan task.
LineCost	A non-persistent attribute to calculate the total cost of the line(ItemQty * UnitCost).
LineType	The type of work plan material. It could be ITEM, MATERIAL, EXTERNAL or SPORDER type.
Location	Primary or alternate location from inventory for this work plan material item.
Storelocsite	Storeroom's Site for this work plan material item.
Manufacturer	The Manufacturer of this work plan material item.
ModelNum	Model number or manufacturer part number for the item of this work plan material.
OrderUnit	Order unit for the item of this work plan material.
OrgId	Identifier of the organization for this failure.
PR	Identifier of the purchase requisition of the ordered item of this work plan material.
PRLineNum	The Purchase requisition Line number of the ordered item of this work plan material.
RequestBy	The Person requesting this item of this work plan material.
RequireDate	The Date this item is needed.
SiteId	Identifier of the site for this failure.
TaskID	A non-persistent attribute to reprsent the task identifier of the Work Order associate with this work plan material.
UnitCost	Item unit cost when work order was approved.
UnitCostHasChanged	Flag tracks if the unit cost 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.
Vendor	Suggested vendor to order this item from.
VendorPackCode	Vendor's pack code for the item.
VendorPackQuantity	Vendor's pack quantity for the item.
VendorUnitPrice	The unit price of the item in vendor's currency.
VendorWareHouse	Vendor's warehouse for the item.
WoNum	Identifier of the work order associate with this work plan material.
WPM1-WPM3	Extra fields, crossover fields from JobMaterial.JM1-JM3.
RATE	The toolrate of the tool. This attribute is applicable to WPTool only.
RaterHasChanged	Set to True when a user manually enters rate for a tool. This attribute is applicable to WPTool only.
Hours	The number of hours that this tool was used for. User-entered value. This attribute is applicable to WPTool only.
RESERVEREQ	Indicates whether or not the tool requires a reservation. This attribute is applicable to WPTool only.

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
WPMaterial(MboSet ms) Basic construtor

Method Summary

Modifier and Type	Method and Description
void	add() Sets Default value for some of the fields of the new wpmaterial.
void	appValidate() Multiple checks are done to validate a WPMaterial.
void	canDelete() Can not delete if there exists an Actual Material for this WPMATERIAL
void	copyPlan(MboRemote source) Used to copy data from a JobMaterial /JobService object.
void	delete(long accessModifier) Subtracts the line cost from WO.EstMatCost.
void	deleteCreatedInvReserves() IV34122: delete the invreserve that was created before an exception, for example, field Issue To requires a value.
void	getItemCostFromInventory() Sets the unitcost to the unitcost from Inventory object.
void	init() Initialize the WPMaterial object, owner must be workorder
boolean	needsStoreroom() Determines if this WPMaterial needs a value for Location attribute.
void	refreshRate() Sets the unitcost (a.k.a rate).
void	save() Saves the WPMaterial and all related Mbos
void	setBaseCurrencyUnitCost(double vendorunitcost) Calculate unitcost based on vendorunitcost and set the unitcost.
void	setEstCost(MboRemote wo, double lineCost) Set the Estimated Material(EstMatCost) Cost in workorder
void	setFieldsFlagInDuplicate() Set fields read only or editable based on the line type, directreq and itemnum.
void	supplyStoreroom() Examines the WPMaterial record and supplies the storeroom when where the record is in need of a storeroom location.
void	undelete() Adds the line cost to WO.EstMatCost.
void	updateEstimateTotal(double delta) Called by custom classes for quantity and rate to update the value of WO.EstMatCost

Methods inherited from class psdi.app.workorder.WPItem

copyHazardForItem, getRequiredMaterialCost, getValidateOrder, isNullQty, propagateKeyValue, setLocation, setVendor, updateTotals, validateStoreLocSite

Methods inherited from class psdi.mbo.Mbo

addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, blindCopy, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkSiteOrgAccessForSave, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, 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, getMboValue, getMboValueData, getMboValueData, getMboValueData, getMboValueDataForDownload, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getProfile, getPropagateKeyFlag, getProxy, getRecordIdentifer, getRecordMboName, getRelatedWhere, getRelatedWhere, getRelationshipNameToLangTable, getResourceName, getRowRestrictionFlag, getRowStamp, getRowStampObject, getSecurityLogger, getSiteOrg, getSqlLogger, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getSynonymValueWhere, getTenantId, getThisMboSet, getTranslator, getUniqueIdentifer, getUniqueIDName, getUniqueIDValue, getUniqueLanguageIDRecord, getUserInfo, getUserName, hasFieldAccess, hasHierarchyLink, hasLockSaveRights, hasRelatedQbe, hasUniqueID, initFieldFlagsOnMbo, initRelationship, isApiBatchError, isAutoKeyed, isBasedOn, isChangeByUserWhenSetFromLookup, 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, select, setAppDefaultValue, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDefaultValue, setDefaultValues, setDeleted, 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, setReferencedMbo, setReferencedMbo, setResolveNoSqlWhere, setResourceName, 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, sigOptionAccessAuthorized, smartFill, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, unlock, unselect, useDataSecurity, validate, validateAttributes, validateKeyUniqueness, valueChanged

Methods inherited from class java.lang.Object

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

Methods inherited from interface psdi.app.workorder.WPItemRemote

isNullQty

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, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, unlock, unselect, validate, validateAttributes

Constructor Detail

WPMaterial

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

Basic construtor

Parameters:

ms - The WPMaterial MboSet.

Throws:

MXException

java.rmi.RemoteException

Method Detail

init

public void init()
          throws MXException

Initialize the WPMaterial object, owner must be workorder

Overrides:

init in class Mbo

Throws:

MXApplicationException - ownerWoWPMaterial when this wpmaterial does not have a owner or its owner is not a workorder.

MXException

add

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

Sets Default value for some of the fields of the new wpmaterial. New wpmaterial can only be created by the work order object.

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
UNITCOSTHASCHANGED	false
storelocsite	false
LineType	ITEM

Specified by:

add in interface MboRemote

Overrides:

add in class WPItem

Throws:

MXApplicationException - ownerWoWPMaterial when this wpmaterial does not have a owner or its owner is not a workorder.

MXException

java.rmi.RemoteException

save

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

Saves the WPMaterial and all related Mbos

Throws:

MXException

java.rmi.RemoteException

appValidate

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

Multiple checks are done to validate a WPMaterial. If this isn't a direct request, the location is needed. If this mbo is brand new (toBeAdded), call copyHazardForItem. Finally, changes to WPMaterial may need to be reflected in the InvReserves.

Overrides:

appValidate in class Mbo

Throws:

MXApplicationException - LocMissing when the method needsStoreroom returns true.

MXApplicationException - (po, NoItemForLineType) is thrown when line type is ITEM and does not have an item number associate with it.

MXApplicationException - (workorder, DescriptionRequired) is thrown when line type is MATERIAL and does not have a description.

java.rmi.RemoteException

MXException

See Also:

needsStoreroom(), WPItem.copyHazardForItem(), psdi.app.workorder.WPMaterial#updateInvReserve

needsStoreroom

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

Determines if this WPMaterial needs a value for Location attribute. Called by appValidate. This method is used by the PM Work Order Generation methods to determine where the work plan needs the PM's store location.

Specified by:

needsStoreroom in interface WPMaterialRemote

Returns:

true if this WPMaterial needs a value for Location attribute.

Throws:

MXException

java.rmi.RemoteException

See Also:

Called here to validate this record., Called here to find WPM missing a storeroom., A PM generate work orders method., A PM generate work orders method., A PM generate work orders method., This is the low-level method which may be catching the "LocMissing" exception.

canDelete

public void canDelete()
               throws MXException

Can not delete if there exists an Actual Material for this WPMATERIAL

Overrides:

canDelete in class Mbo

Throws:

MXAccessException - deletewpmaterial when there exists an Actual Material for this WPMaterial.

MXException

refreshRate

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

Sets the unitcost (a.k.a rate).

Throws:

MXApplicationException - ItemNotFound when the item is not exist in Item table.

java.rmi.RemoteException

MXException

getItemCostFromInventory

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

Sets the unitcost to the unitcost from Inventory object.

Throws:

MXApplicationException - InventoryNotFound when the item can not be found in specified location in inventory object.

java.rmi.RemoteException

MXException

updateEstimateTotal

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

Called by custom classes for quantity and rate to update the value of WO.EstMatCost

Parameters:

delta - the cost need be added to WO.EstMatCost.

Throws:

MXException

java.rmi.RemoteException

setEstCost

public void setEstCost(MboRemote wo,
                       double lineCost)
                throws MXException,
                       java.rmi.RemoteException

Set the Estimated Material(EstMatCost) Cost in workorder

Overrides:

setEstCost in class WPItem

Throws:

MXException

java.rmi.RemoteException

delete

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

Subtracts the line cost from WO.EstMatCost. When the last WPMaterial is deleted, WO.EstMatCost is editable.

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.

Throws:

MXException

java.rmi.RemoteException

See Also:

WPMaterialSet.checkToRemoveHazardInfo(String)

undelete

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

Adds the line cost to WO.EstMatCost. If the MboSet was empty before, WO.EstMatCost is zero'ed out and made read-only.

Specified by:

undelete in interface MboRemote

Overrides:

undelete in class Mbo

Throws:

MXException

java.rmi.RemoteException

setBaseCurrencyUnitCost

public void setBaseCurrencyUnitCost(double vendorunitcost)
                             throws MXException,
                                    java.rmi.RemoteException

Calculate unitcost based on vendorunitcost and set the unitcost.

Overrides:

setBaseCurrencyUnitCost in class WPItem

Throws:

MXException

java.rmi.RemoteException

setFieldsFlagInDuplicate

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

Set fields read only or editable based on the line type, directreq and itemnum. It will be called by WO duplicate method.

Specified by:

setFieldsFlagInDuplicate in interface WPMaterialRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

setFieldsFlagInDuplicate()

copyPlan

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

Description copied from class: WPItem

Used to copy data from a JobMaterial /JobService object.

Specified by:

copyPlan in interface WorkPlanMbo

Overrides:

copyPlan in class WPItem

Parameters:

source - The JobMaterial /JobService Mbo used to copy data from.

Throws:

MXException

java.rmi.RemoteException

See Also:

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

supplyStoreroom

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

Examines the WPMaterial record and supplies the storeroom when where the record is in need of a storeroom location. This method uses the needsStoreroom method to determine if the location is needed. This method is called by PM Work Order generation methods and by Work Order's Apply Route. If WPMaterial records still need a storeroom location, the user's Labor StoreLocation is supplied. Finally, the supplied site's default storeroom will be used.

Throws:

java.rmi.RemoteException

MXException

See Also:

psdi.app.workorder.WPMaterial#needsStoreroom., PM.generateWork(boolean, int, boolean), PM.calculateWork(boolean, java.util.Date), psdi.app.signature.SignatureService#getlaborForuserAndOrg, If set, this takes precedence., If set, this takes precedence.

deleteCreatedInvReserves

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

IV34122: delete the invreserve that was created before an exception, for example, field Issue To requires a value.

Throws:

MXException

java.rmi.RemoteException