psdi.app.po

Class Shipment

java.lang.Object

psdi.mbo.Mbo

psdi.app.po.Shipment

All Implemented Interfaces:

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

public class Shipment
extends Mbo
implements ShipmentRemote

MBO to represent Shipment (Advanced Ship Notice). The Advanced Ship Notice transaction will be sent by the vendor when the goods are being shipped. This transaction will detail all of the shipping related information.

See Purchase Order Package description.

This is a site level object.

The key attributes for this object are SiteId and ShipmentId.

The attributes in this object are as follows:

Attribute Name	Description
BillOfLading	Bill of Lading details.
BillTo	Address to send the bill to.
Carrier	Transportation agency handling the shipment.
CarrierMethod	Type of Carrier, Air/Road/Sea etc.
CarrierVehicleNum	Vehicle number of the carrier.
DropPoint	The point where the items are to be delivered.
EnterBy, EnterDate	Name of the person who entered this shipment; date on which this shipment was entered.
ExpReceiptDate	Expected Date of Receipt of the item.
FOB	Freight on Board. The point where responsibility and liability are transferred.
FreightAmount	Freight Amount.
FreightBillNum	Number of Freight Bill.
FreightTerms	The terms under which the shipment is made. For example, this field may contain "Perishable goods. Deliver ASAP".
GrossWeight	Gross weight of the Shipment.
GrossWeightUOM	Unit of measurement in which the gross weight is expressed.
NetWeight	Net weight of the Shipment.
NetWeightUOM	Unit of measurement in which the net weight is expressed.
NumOfPackages	Number of packages in the Shipment.
OrgId	Identifier of the organization for this shipment.
PackingSlipNum	Packing Slip Number.
PaymentTerms	Terms of payment.
ShipDate	Date of the Shipment.
ShipmentId	The primary key of this table. A unique identifier to each Shipment.
ShipmentNum	The shipment document reference number provided by supplier.
ShipTo	Address where items are to be shipped to.
SiteId	Identifier of the site for this shipment.
SpecialHandling	Special handling instructions of the shipment.
Status	Status of the Shipment. New or Cancel.
Vendor	Vendor of the Shipment.
WayBillNum	Way Bill Number.

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
Shipment(MboSet ms) Construct the Shipment object

Method Summary

Modifier and Type	Method and Description
void	add() Adds a new Shipment.
void	appValidate() appValidate for a new Shipment.It checks if vendor is null the fromsiteid cannot be null.
MboRemote	createShipmentReceipt(MboSetRemote existingReceiptSet, long shipmentlinenum, java.lang.String ownersysid) Returns a MatRecTrans mbo to the caller InvUseService.createShipmentReceipt() The method is created for API,Wireless, and GUI
MboRemote	createShipmentReturn(MboSetRemote existingReceiptSet, long shipmentlinenum, java.lang.String ownersysid) Returns a MatRecTrans mbo to the caller InvUseService.createShipmentReturn() The method is created for API,Wireless, and GUI
void	generateAutoKey() Shipment Object allows the generation of autokeys.
void	init() Called by the framework when the Mbo has been constructed and the MboValues have been initialized.
void	initRelationship(java.lang.String relationName, MboSetRemote mboSet) Called whenever a relationship is initialized or reset from this Mbo to another MboSet.
void	setReceiptVariables(MboRemote receipt, MboRemote shipmentLineRemote) This method sets the values from shipmentline to matrectrans.

Methods inherited from class psdi.mbo.Mbo

addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, 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, fireEvent, 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, initFieldFlagsOnMbo, 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, 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, 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

addMboSetForRequiredCheck, addToDeleteForInsertList, blindCopy, checkMethodAccess, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, delete, duplicate, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, excludeObjectForPropagate, 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

Constructor Detail

Shipment

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

Construct the Shipment object

Throws:

MXException

java.rmi.RemoteException

Method Detail

init

public void init()
          throws MXException

Description copied from class: Mbo

Called by the framework when the Mbo has been constructed and the MboValues have been initialized. This can be overridden by the programmer to provide any custom initialization they would like to do.

Overrides:

init in class Mbo

Throws:

MXException

add

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

Adds a new Shipment. Required fields of this object are initialised in this method.

Attribute Name	Attribute Value
enterdate	Current Date
enterby	Current User
shipdate	Current Date
shipmentid	Unique ID

Specified by:

add in interface MboRemote

Overrides:

add in class Mbo

Throws:

MXException

java.rmi.RemoteException

generateAutoKey

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

Shipment Object allows the generation of autokeys. Overrides the generateAutoKey() in the Mbo

Specified by:

generateAutoKey in interface MboRemote

Overrides:

generateAutoKey in class Mbo

Throws:

MXException

java.rmi.RemoteException

See Also:

Mbo.generateAutoKey()

initRelationship

public void initRelationship(java.lang.String relationName,
                             MboSetRemote mboSet)
                      throws MXException,
                             java.rmi.RemoteException

Description copied from class: Mbo

Called whenever a relationship is initialized or reset from this Mbo to another MboSet. Programmers can override this method for custom handling of related objects. An example of this would be making the WPMATERIAL object read only if the status of the Work Order is CLOSED.

Overrides:

initRelationship in class Mbo

Throws:

MXException

java.rmi.RemoteException

createShipmentReceipt

public MboRemote createShipmentReceipt(MboSetRemote existingReceiptSet,
                                       long shipmentlinenum,
                                       java.lang.String ownersysid)
                                throws MXException,
                                       java.rmi.RemoteException

Returns a MatRecTrans mbo to the caller InvUseService.createShipmentReceipt() The method is created for API,Wireless, and GUI

Specified by:

createShipmentReceipt in interface ShipmentRemote

Parameters:

1: - existingReceiptSet: if existingReceiptSet is not null we want to add a new receipt (MatRecTrans) mbo to the existing set. Otherwise, create a new set

Returns:

A newly created MatRecTrans Mbo.

Throws:

MXApplicationException(inventory, - mxcollabRC) is thrown when the integration rules specify that the receipt cannot be created.

MXApplicationException(shipment, - InvalidShipmentLineNum) is thrown when the shipmentlinenum that was passed into this method as a parameter is an invalid shipmentlinenum.

MXException

java.rmi.RemoteException

See Also:

Shipment.createShipmentReceipt(MboSetRemote existingReceiptSet,long shipmentlinenum,String ownersysid)

setReceiptVariables

public void setReceiptVariables(MboRemote receipt,
                                MboRemote shipmentLineRemote)
                         throws MXException,
                                java.rmi.RemoteException

This method sets the values from shipmentline to matrectrans.

Parameters:

receipt -

shipmentLineRemote -

Throws:

MXException

java.rmi.RemoteException

createShipmentReturn

public MboRemote createShipmentReturn(MboSetRemote existingReceiptSet,
                                      long shipmentlinenum,
                                      java.lang.String ownersysid)
                               throws MXException,
                                      java.rmi.RemoteException

Returns a MatRecTrans mbo to the caller InvUseService.createShipmentReturn() The method is created for API,Wireless, and GUI

Parameters:

1: - existingReceiptSet: if existingReceiptSet is not null we want to add a new receipt (MatRecTrans) mbo to the existing set. Otherwise, create a new set

Returns:

A newly created MatRecTrans Mbo.

Throws:

MXApplicationException(inventory, - mxcollabRC) is thrown when the integration rules specify that the receipt cannot be created.

MXApplicationException(shipment, - InvalidShipmentLineNum) is thrown when the shipmentlinenum that was passed into this method as a parameter is an invalid shipmentlinenum.

MXException

java.rmi.RemoteException

appValidate

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

appValidate for a new Shipment.It checks if vendor is null the fromsiteid cannot be null. This shipment is created from Inventory Usage application.

Overrides:

appValidate in class Mbo

Throws:

MXException

java.rmi.RemoteException