psdi.app.compmaster

Class CompMaster

java.lang.Object

psdi.mbo.Mbo

psdi.app.compmaster.CompMaster

All Implemented Interfaces:

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

public class CompMaster
extends Mbo
implements CompMasterRemote

Mbo object to represent a company master.

See Company Master Package description.

The key attributes for this object are Company and CompanySetId.

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 disabled.
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.
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.
Co11 - Co18	Extra fields.

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

Method Summary

Modifier and Type	Method and Description
void	add() Set default values for some of the fields of the new company master.
void	appValidate() If the punchoutenabled flag is set to 'Y' the catalogname field is required.
void	canDelete() A company master record may not be deleted if any organization was a corresponding company record in use.
MboSetRemote	createCompaniesForOrgs(MboSetRemote organizationSetRemote) Creates a company from this company master for each organization selected.
void	delete(long accessModifier) Deletes the Company Master and all related contact master.
java.util.Vector	getAttributesToCopy(boolean copyModifiedOnly) Utility method returns a vector containing the names of all attributes that must be updated on a matching company Mbo.
void	init() Initialization rountine.
void	modify() Modify() is called whenever a change is made to the attributes of company master.
protected void	save() Actions that occur when a company master object is saved.
void	setContactInfo(MboRemote cont) Set value of primaryContactOfCompany variable.
void	setRemitContactInfo(MboRemote remitCont) Set value of remitContactOfCompany variable.
void	updateRelatedCompanyContacts() If this CompMaster has any CompContactMaster records that were modified, make the same updates to the corresponding company contact record, if it exists.

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, getValidateOrder, 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, 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, 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, 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, undelete, unlock, unselect, validate, validateAttributes

Constructor Detail

CompMaster

public CompMaster(MboSet ms)
           throws java.rmi.RemoteException

Construct the Company Master object.

Parameters:

ms -

Throws:

java.rmi.RemoteException

Method Detail

init

public void init()
          throws MXException

Initialization rountine. Sets company attribute read only if not a new Mbo.

Overrides:

init in class Mbo

Throws:

MXException

add

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

Set default values for some of the fields of the new company master. 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
companysetid	Company set identifier for the current organization.
currencycode	BaseCurrency1 if there is a base currency, else do not default.
disabled	No
ecommerceenabled	No
payonreceipt	No
punchoutenabled	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

Modify() is called whenever a change is made to the attributes of company master. When any field related to company master is changed, changedate and changeby are updated.

Overrides:

modify in class Mbo

Throws:

MXException

java.rmi.RemoteException

save

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

Actions that occur when a company master object is saved.

• If "updaterelatedcos" is selected and the company master is modified, corresponding company records are updated.
• The company contact master records are always updated to match the company master. If a newly added contact and remit contact are the same, only one can be saved because duplicates are not allowed. There may be at most one primary contact and one remit contact therefore unused contacts must be deleted.
• If "updaterelatedcos" is selected and a company contact is modified, corresponding company contact records are updated.
• super.save() is called

Overrides:

save in class Mbo

Throws:

MXException

java.rmi.RemoteException

updateRelatedCompanyContacts

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

If this CompMaster has any CompContactMaster records that were modified, make the same updates to the corresponding company contact record, if it exists.

Throws:

MXException

java.rmi.RemoteException

getAttributesToCopy

public java.util.Vector getAttributesToCopy(boolean copyModifiedOnly)
                                     throws MXException,
                                            java.rmi.RemoteException

Utility method returns a vector containing the names of all attributes that must be updated on a matching company Mbo. The vector will only contain modified attributes if the passed parameter modifiedOnly is true. The attributes updaterelatedcos, changeby, changedate, companysetid, compmasterid, and ldkey are always skipped.

Specified by:

getAttributesToCopy in interface CompMasterRemote

Parameters:

copyModifiedOnly - if true, copies only modified attributes

Throws:

MXException

java.rmi.RemoteException

See Also:

CompMaster.getAttributesToCopy(boolean copyModifiedOnly)

canDelete

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

A company master record may not be deleted if any organization was a corresponding company record in use.

Overrides:

canDelete in class Mbo

Throws:

MXApplicationException -

GROUP	KEY	REASON
compmaster	cannotDeleteCompMaster	Cannot delete a company master that has been added to an organization.

MXException

java.rmi.RemoteException

delete

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

Deletes the Company Master and all related contact master. When the Company Master is deleted, associated records in the COMPCONTACTMSTR table will also be deleted.

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. For example: if the accessModifer is NOACCESSCHECK, then the check for the object's NODELETE flag and the call to the object's canDelete() method will not be performed. If the accessModifer is NONE, then all the access checks are performed before this object is marked delete.

Throws:

MXException

java.rmi.RemoteException

See Also:

Mbo.delete(long)

appValidate

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

If the punchoutenabled flag is set to 'Y' the catalogname field is required. Immitates logic of Company object.

Overrides:

appValidate in class Mbo

Throws:

MXApplicationException - (compmaster, catalogNameRequired) Catalog name is required.

MXException

java.rmi.RemoteException

createCompaniesForOrgs

public MboSetRemote createCompaniesForOrgs(MboSetRemote organizationSetRemote)
                                    throws MXException,
                                           java.rmi.RemoteException

Creates a company from this company master for each organization selected. The user selects organizations in a table window. If an organization already has this company, the organization is ignored. Does nothing if no organizations are selected.

Specified by:

createCompaniesForOrgs in interface CompMasterRemote

Parameters:

organizationSetRemote - The set of organizations for which this company will be created.

Throws:

MXException

java.rmi.RemoteException

See Also:

CompMaster.createCompaniesForOrgs(MboSetRemote organizationSetRemote)

setRemitContactInfo

public void setRemitContactInfo(MboRemote remitCont)
                         throws MXException,
                                java.rmi.RemoteException

Set value of remitContactOfCompany variable. Holds a reference to a company Mbos remit contact company contact Mbo.

Specified by:

setRemitContactInfo in interface CompMasterRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

CompMaster.setRemitContactInfo(MboRemote remitContact)

setContactInfo

public void setContactInfo(MboRemote cont)
                    throws MXException,
                           java.rmi.RemoteException

Set value of primaryContactOfCompany variable. Holds a reference to a company Mbos primary contact company contact Mbo.

Specified by:

setContactInfo in interface CompMasterRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

CompMaster.setContactInfo(MboRemote contact)