psdi.app.company

Class Company

java.lang.Object

psdi.mbo.Mbo

psdi.app.company.Company

All Implemented Interfaces:

java.rmi.Remote, CompanyRemote, LinkedMboRemote, MboConstants, MboRemote, MaxRemoteProxy

public class Company
extends Mbo
implements CompanyRemote, LinkedMboRemote

Mbo object to represent companies. The Company object maintains detailed information on vendors, manufacturers, and other companies. The information entered includes the company identification, addresses, purchasing details (currency, tax, shipping), and payment details (bank and internal accounts, and whether the company has a payment on receipt agreement). For reporting purposes, companies can be grouped by type, such as vendor or manufacturer. You can also enter your own company's storeroom locations here so that these locations become "vendors" for internal purchase orders (i.e., transfers from one storeroom location to another). The Company object must have the company information before other objects, such as Inventory and Purchasing, can access it.

See Company Package description.

The key attribute for this object is Company.

The attributes in this object are as follows:

Attribute Name	Attribute Description
Address1	Street address of the company.
Address2	City where the company is located.
Address3	State or province where the company is located.
Address4	Company's zip or postal code.
APControlAcc	Accounts Payable Control Account. Used when an invoice is paid.
APSuspenseAcc	Accounts Payable Suspense Account. Used when an invoice is approved.
AutoApproveInv	Yes/No field indicates whether or not invoices should automatically be approved for the vendor upon receipt of the invoice.
AutoRecieveOnASN	Yes/No field indicates whether or not the vendor should automatically process the receipts for an automated shipping notification.
AutoSendPOCancel	Yes/No field indicates whether or not the vendor is sent a transaction when a purchase order is cancelled.
BankAccount	Company's bank account for direct payments.
BankNum	Company's bank and branch identification reference number. Used when transferring funds electronically.
CatalogName	Name of the catalog that will display when punching out.
ChangeBy, ChangeDate	Name of the user who last updated this object and the date updated.
Company	Identifier for the company.
Contact	Name of the primary person to contact at the company.
CurrencyCode	Currency used by the company.
CustomerNum	Number used by an outside company to identify your own company.
Disabled	Yes/No field indicates whether or not the company is disqualified.
DUNSNum	Data Universal Numbering System Number. Used to uniquely identify a company and its location.
EcomInterface	E-Commerce supplier's catalog location.
EcommerceEnabled	Yes/No field indicates whether or not the company has the capability of electronic commerce with MAXIMO.
ExternalRefId	External Reference Identifier.
Fax	Fax number of the company or contact.
FOB	Free On Board. The point where responsibility and liability are transferred.
FreightTerms	Description of what is being shipped. Riders to the shipping agreement should be included here.
HomePage	URL for the company's World Wide Web page.
Inclusive1 - Inclusive5	Yes/No fields indicate whether or not tax1code - tax5code are included in the invoicing cost.
Location	Location of the company.
MNetCompanyId	MNet assigned company identification number.
Name	Name and/or description of the company. Long description enabled.
OrgId	Organization Identifier.
OwnerSysId	Owner System Identifier.
PaymentTerms	Terms of payment for this vendor.
PayOnReceipt	Yes/No field indicates whether or not a payment on receipt agrement exists with this company.
PayVendor	Name of the person to whom payments should be sent.
Phone	Telephone number of the company or contact.
PunchOutEnabled	Yes/No field indicates whether this vendor's catalog can be accessed through punchout.
RBNIAcc	Account for receipts that have not been approved.
Registeration1 - Registeration5	Tax registration numbers for tax types 1 - 5 used by the company.
RemitAddress1	Street address of the remit to company.
RemitAddress2	City of the remit to company.
RemitAddress3	State or province of the remit to company.
RemitAddress4	Zip or postal code of the remit to company.
RemitContact	Name of the person at the remit to company to contact for invoicing.
ShipVia	How the goods should be shipped.
SourceSysId	Source System Identifier.
Tax1Code - Tax5Code	Country or state tax codes of tax types 1 - 5 for this company.
TaxExemptCode	Indicates whether the company is exempt from paying taxes.
TaxExemptNum	National tax exemption number used for tax reporting purposes.
VendorSendsASN	Yes/No field indicates whether or not the vendor should send automated shipping notification transactions.
VendorSendsInv	Yes/No field indicates whether or not the vendor should send invoice transactions.
VendorSendsStatus	Yes/No field indicates whether or not the vendor should send status transactions.
Type	The company's type.

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

Method Summary

Modifier and Type	Method and Description
void	add() Default value for some of the fields of the new company.
void	appValidate() This method is called by the framework before save.
void	canDelete() Overwitten for company's MBO.
CompMasterRemote	createMasterForCompany() Creates a company master for this company Mbo.
void	delete(long accessModifier) Overwitten for company's MBO.
MboRemote	duplicate() Duplicates a Company record.
void	init() Initialize rountine.
void	initFieldFlagsOnMbo(java.lang.String attrName) The logic of setting the readonly and required field flags for Company Mbo.
boolean	isDisabled() Return true or false to indicate if this company is disabled.
void	modify() This is called whenever a change is made to the attributes of company.
protected void	save() Actions that occur when a company object is saved.
void	setDisabled(boolean disabled) Set the disabled field of the company object.
protected boolean	skipCopyField(MboValueInfo mvi) Overrides the skipCopyField() in the Mbo.

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, 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, getValidateOrder, hasFieldAccess, hasHierarchyLink, hasLockSaveRights, hasRelatedQbe, hasUniqueID, 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, moveFieldFlagsToMboValue, needCallInitFieldFlag, orEvaluateConditions, propagateKeyValue, removeCtx, removeRelatedSet, resolveNoSqlWhere, rollbackToCheckpoint, 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, 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, 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, undelete, unlock, unselect, validate, validateAttributes

Constructor Detail

Company

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

Construct the Company object.

Parameters:

ms -

Throws:

MXException

java.rmi.RemoteException

Method Detail

init

public void init()
          throws MXException

Initialize rountine.

Overrides:

init in class Mbo

Throws:

MXException

initFieldFlagsOnMbo

public void initFieldFlagsOnMbo(java.lang.String attrName)
                         throws MXException

The logic of setting the readonly and required field flags for Company Mbo.

Overrides:

initFieldFlagsOnMbo in class Mbo

Throws:

MXException

add

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

Default value for some of the fields of the new company. The table below shows the default values for each of the attributes listed.

Attribute Name	Attribute Value
autoapproveinv	No
autoreceiveonasn	No
autosendpocancel	No
changeby	Current username
changedate	Current date
currencycode	BaseCurrency1 if there is a base currency, else do not default.
disabled	No
ecommerceenabled	No
inclusive1 - inclusive5	Yes
payonreceipt	No
punchoutenabled	No
useparentremitto	No
vendorsendsasn	No
vendorsendsinv	No
vendorsendsstatus	No

Specified by:

add in interface MboRemote

Overrides:

add in class Mbo

Throws:

MXException

java.rmi.RemoteException

modify

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

This is called whenever a change is made to the attributes of company. When any field related to company is changed, changedate and changeby is updated.

Overrides:

modify in class Mbo

Throws:

MXException

java.rmi.RemoteException

isDisabled

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

Return true or false to indicate if this company is disabled.

Specified by:

isDisabled in interface CompanyRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

Company.isDisabled()

setDisabled

public void setDisabled(boolean disabled)
                 throws MXException,
                        java.rmi.RemoteException

Set the disabled field of the company object. Rule checking is enabled.

Specified by:

setDisabled in interface CompanyRemote

Parameters:

disabled -

Throws:

MXException

java.rmi.RemoteException

See Also:

Company.setDisabled(boolean)

save

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

Actions that occur when a company object is saved. If this is a new company, a new company master will be created and company contact masters for the primary and remit contacts will also be created.

Overrides:

save in class Mbo

Throws:

MXException

java.rmi.RemoteException

canDelete

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

Overwitten for company's MBO. Delete is not allowed if the COMPANY is referenced by certain objects. A company cannot be deleted if the following conditions exist:

• If this company is used as a parent on any other company.
• Any records exist in INVVENDOR with either vendor or manufacturer equal to the company.
• Any records exist in INVENTORY with either vendor or manufacturer equal to the company.
• Any records exist in ASSET with either vendor or manufacturer equal to the company.
• Any records exist in JOBLABOR with vendor equal to the company.
• Any records exist in JOBMATERAIL with vendor equal to the company.
• The location attribute for this company is not null.
• Any records exist in PO with vendor, shipto or billto equal to the company, and the status of the PO is not close or cancel.
• Any records exist in PR with vendor, shipto or billto equal to the company, and the status of the PR is not close or cancel.
• Any records exist in INVOICE with vendor equal to the company, and the status of the INVOICE is not cancel.
• Any records exist in SERVICECONTRACT with vendor equal to the company.
• Any records exist in MRLINE with either vendor or manufacturer equal to the company, and the status of the MR is not close.
• Any records exist in WPMATERIAL with vendor equal to the company, and the workorder status not equal to close or cancel.
• Any records exist in WPLABOR with vendor equal to the company, and the workorder status not equal to close or cancel.
• Any records exist in RFQ with buyercompany, billto, replyto,or shipto equal to the company, and the status of the RFQ is not close.
• Any records exist in RFQ with buyercompany, billto, replyto,or shipto equal to the company, and the status of the RFQ is not close.
• Any records exist in RFQLINE or RFQVENDOR with vendor equal to the company, and the status of the RFQ is not close.

Overrides:

canDelete in class Mbo

Throws:

MXApplicationException - (company, deletecompany) Cannot delete company.

MXException

java.rmi.RemoteException

delete

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

Overwitten for company's MBO. If the the mbo is marked to be deleted in the hierarchy i.e. the branch company needs to be deleted, delete the relationship between parent and branch . Delete any contacts in COMPCONTACT referenced by the company to be deleted.

Specified by:

delete in interface MboRemote

Overrides:

delete in class Mbo

Parameters:

long - accessModifier

Throws:

MXException

java.rmi.RemoteException

See Also:

Mbo.delete(long)

duplicate

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

Duplicates a Company record. Also duplicates the contacts for this company which are stored in the COMPCONTACT table and the related Linked Documents(DocLinks).

Specified by:

duplicate in interface MboRemote

Overrides:

duplicate in class Mbo

Returns:

MboRemote The newly created company.

Throws:

MXException

java.rmi.RemoteException

skipCopyField

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

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 skipped by using the data from the static HashSet. If this field does not need to be copied return true. The following are the Company fields will be skipped without being copied to the newly duplicated company:

1. company
2. changeby
3. changedate
4. sourcesysid
5. ownersysid
6. externalrefid
7. sendersysid
8. orgid

Overrides:

skipCopyField in class Mbo

Parameters:

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

Returns:

true If the field does not need to be copied return true, in all other cases return false.

Throws:

MXException

java.rmi.RemoteException

See Also:

Company.loadSkipFieldCopyHashSet()

appValidate

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

This method is called by the framework before save. Perform regular appValidate() and process LinkedMbo's deletion. If the punchoutenabled flag is set to 'Y' the catalogname field will be required.

Overrides:

appValidate in class Mbo

Throws:

MXApplicationException - (company, CatalogNameRequired) Catalog name is required.

MXException

java.rmi.RemoteException

createMasterForCompany

public CompMasterRemote createMasterForCompany()
                                        throws MXException,
                                               java.rmi.RemoteException

Creates a company master for this company Mbo. If a company master already exists this method just returns.

Returns:

CompMasterRemote new company master Mbo

Throws:

MXException

java.rmi.RemoteException