psdi.app.contract.lease

Class LeaseView

java.lang.Object

psdi.mbo.Mbo

psdi.mbo.StatefulMbo

psdi.app.common.purchasing.PurchasingMbo

psdi.app.contract.Contract

psdi.app.contract.lease.LeaseView

All Implemented Interfaces:

java.rmi.Remote, PurchasingMboRemote, ContractRemote, LeaseViewRemote, MboConstants, MboRemote, StatefulMboRemote, MaxRemoteProxy

public class LeaseView
extends Contract
implements LeaseViewRemote

MBO object to represent the view containing the Contract and the Purchase Contract tables. Like all objects, views also extend from Mbo.

Field Summary

Fields inherited from class psdi.app.common.purchasing.PurchasingMbo

checkLimitWhenApprove

Fields inherited from class psdi.mbo.StatefulMbo

onListTab, statusChangeButtonSigoption, targetStatusOption

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

Method Summary

Modifier and Type	Method and Description
void	add() Add method on the Leave Contract View.
void	applyPriceAdjustment(MboSetRemote contractLineSetRemote)
void	applyPriceToLines() Apply the adjusted prices to the linecost of the contractLine.
void	appValidate() Pre-save validation method.
void	canAddAssetToContractAsset() Method to check if a row can be added to the associated assets tab.
void	cancelInvoices(MboSetRemote assetSet) Cancel all the unpaid invoices which were created for the passed in assets.
void	canCreateSchedule() Cannot add a new payment schedule for an lease contract unless it is approved.
void	canPurchaseOrReturnAsset() Can perform "Purchase" or "Return" assets "End Lease" actions for approved contracts only
void	changeStatus(java.lang.String status, java.util.Date date, java.lang.String memo, long accessModifier) This method is overridden to add a wrapper to exceptions thrown during change status and to write warnings whether or not the status change is successful
void	copyAssetsToContractAsset(AssetSetRemote assetSetRemote) Copies the selected Asset values to the CONTRACTASSET.
void	createEndLeaseInvoice(java.lang.String invNumber, java.lang.String targetStatus, MboSetRemote assetSet, boolean purchaseFlag) Create invoice for purchase assets belonging to a lease contract (Lease End action).
void	createEndLeasePO(java.lang.String poNumber, java.lang.String targetStatus, MboSetRemote assetSet, boolean purchaseFlag)
MboRemote	duplicate() Duplicates a Contract,its lines and cost lines Creates a duplicate Purchase Order.
java.lang.String	getStatusListName() Return the string "CONTRACTSTATUS".
void	init() Initialize the Purchase Contract View object.
void	initRelationship(java.lang.String relationName, MboSetRemote mboSet) Called whenever a relationship is initialized or reset from this Mbo to another MboSet.
void	nullVendor() Throws an exception if the vendor on the LEASEVIEW Header is null.
double	reCalcLeaseViewCost() This method recalculates the lease view's total cost if the line cost on any of its payment schedule lines changes.
MboRemote	reviseContract(java.lang.String revDescription) Creates a new revision of the current contract.
void	setRentalReadOnlyFields() Sets some fields to read only if the contract type is rental

Methods inherited from class psdi.app.contract.Contract

addInvVendorItemsToContractLine, canAuthSites, cancelOrSusupndPreviousRevision, canChangeLineStatus, canDelete, canEditContractLine, canPerformAction, canReviseContract, changeLineStatus, checkMasterMaxValue, copySitesToContractAuth, copySLAToSLAContract, doesContractReferenceExistOnPO, findLatestMasterRevision, getAssetList, getAvailableFunds, getContractReleaseSeqNumber, getInternalContractType, getInvoiceCreationFlag, getLocationsList, getNextRevision, getNextRevisionReference, getPreviousRevision, getRouteWF, isRevisionInProgress, modify, prevStatusRemainApproved, revisionInProgress, setContractTypeEditibilityAndValues, setContractTypeTerm, setInvoiceCreationFlag, setNextRevisionReference, setRouteWF, useLineOrLoadedCost, validateContract, validateDates

Methods inherited from class psdi.app.common.purchasing.PurchasingMbo

addConsignmentItems, checkConsignmentItems, checkConsignmentItemsInContractSet, checkContractType, checkInvalidItemStatus, compareCopyTerms, copyAllTerms, copyContarctTerm, copyContractToPOPR, copyFromContract, copyTerms, createContractHeader, getContractAuth, getExchangeRate, getExchangeRate2, getInvoiceMgtMaxVar, getPOPRLineSet, getShowconswarningFlag, noLimitWhenApprove, nullVendorContract, recalculateTotalCost, recalculateTotalTax, setPOPRLineSet, setShowconswarningFlag, showConsVendorWarningMessage, showConsVendorWarningMessageForContracts

Methods inherited from class psdi.mbo.StatefulMbo

canChangeMaxStatus, canChangeStatus, canChangeStatus, canChangeStatus, canDeleteAttachedDocs, changeMaxStatus, changeMaxStatus, changeStatus, changeStatus, checkForOpenStatus, checkStatusChangeAuthorization, filterByValidStatusList, fireEvent, getInternalStatus, getOnListTab, getOverridePVStatusException, getStatusChangeButtonSigoption, getStatusList, getTargetStatusOption, getValidStatusList, setOnListTab, setOverridePVStatusException, setStatusChangeButtonSigoption, setTargetStatusOption

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, delete, determineRequiredFieldsFromERM, enableMethod, evaluateCondition, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, evaluateRestriction, excludeObjectForPropagate, findAllNullRequiredFields, 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, getValidateOrder, hasFieldAccess, hasHierarchyLink, hasLockSaveRights, hasRelatedQbe, hasUniqueID, initFieldFlagsOnMbo, isApiBatchError, isAutoKeyed, isBasedOn, isChangeByUserWhenSetFromLookup, 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, 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, undelete, 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.contract.ContractRemote

addInvVendorItemsToContractLine, canAuthSites, canChangeLineStatus, canPerformAction, canReviseContract, changeLineStatus, copySitesToContractAuth, copySLAToSLAContract, getAssetList, getAvailableFunds, getContractReleaseSeqNumber, getInternalContractType, getLocationsList, getRouteWF, isRevisionInProgress, revisionInProgress, setRouteWF, validateDates

Methods inherited from interface psdi.app.common.purchasing.PurchasingMboRemote

copyContarctTerm, copyContractToPOPR, copyTerms, getPOPRLineSet, noLimitWhenApprove, nullVendorContract, showConsVendorWarningMessageForContracts

Methods inherited from interface psdi.mbo.StatefulMboRemote

canChangeMaxStatus, canChangeStatus, canChangeStatus, canDeleteAttachedDocs, changeMaxStatus, changeMaxStatus, changeStatus, changeStatus, checkForOpenStatus, getInternalStatus, getOnListTab, getOverridePVStatusException, getStatusChangeButtonSigoption, getStatusList, getTargetStatusOption, getValidStatusList, setOnListTab, setOverridePVStatusException, setStatusChangeButtonSigoption, setTargetStatusOption

Methods inherited from interface psdi.mbo.MboRemote

addMboSetForRequiredCheck, addToDeleteForInsertList, blindCopy, checkMethodAccess, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, 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, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, unlock, unselect, validate, validateAttributes

Constructor Detail

LeaseView

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

Construct the LeaseView object.

Parameters:

ms -

Throws:

MXException

java.rmi.RemoteException

Method Detail

init

public void init()
          throws MXException

Initialize the Purchase Contract View object.

Overrides:

init in class Contract

Throws:

MXException

getStatusListName

public java.lang.String getStatusListName()

Return the string "CONTRACTSTATUS".

Specified by:

getStatusListName in interface StatefulMboRemote

Overrides:

getStatusListName in class Contract

Returns:

= The listname for status in the ValueList table.

add

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

Add method on the Leave Contract View.

Specified by:

add in interface MboRemote

Overrides:

add in class Contract

Throws:

MXException

java.rmi.RemoteException

duplicate

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

Duplicates a Contract,its lines and cost lines

1. Creates a duplicate Purchase Order.
2. The add method of Contract sets the status of the duplicated Purchase order to WAPPR.
3. Autokeys the ContractNum if the autokey feature is turned on. If the autokey feature is turned off, the user must input the key value. The save() method checks for the key and throws an exception if the key is not entered.

Specified by:

duplicate in interface MboRemote

Overrides:

duplicate in class Mbo

Returns:

MboRemote-the newly duplicated Contract

Throws:

MXException

java.rmi.RemoteException

See Also:

Mbo.isAutoKeyed(java.lang.String)

appValidate

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

Description copied from class: Mbo

Pre-save validation method. Programmer can override with specific rules.

Overrides:

appValidate in class Mbo

Throws:

java.rmi.RemoteException

MXException

nullVendor

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

Throws an exception if the vendor on the LEASEVIEW Header is null.

Specified by:

nullVendor in interface PurchasingMboRemote

Specified by:

nullVendor in interface ContractRemote

Specified by:

nullVendor in interface LeaseViewRemote

Overrides:

nullVendor in class Contract

Throws:

MXApplicationException("po", - "vendorIsNull");

MXException

java.rmi.RemoteException

See Also:

PurchasingMbo.nullVendor()

initRelationship

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

Called whenever a relationship is initialized or reset from this Mbo to another MboSet. Set the editibility of the Mbos related to the contract. The initRelationship() only when the relationship name that is specified inside this method is used to obtain the target MboSet.

Overrides:

initRelationship in class Contract

Parameters:

relationName - the relationship name

mboSet - the mboset

Throws:

MXException

java.rmi.RemoteException

canCreateSchedule

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

Cannot add a new payment schedule for an lease contract unless it is approved. The current date should be before the last schedule date.

Specified by:

canCreateSchedule in interface LeaseViewRemote

Throws:

MXApplicationException("contract", - "AfterLastScheduleDate")

MXException

java.rmi.RemoteException

See Also:

psdi.app.contract.lease

reCalcLeaseViewCost

public double reCalcLeaseViewCost()
                           throws MXException,
                                  java.rmi.RemoteException

This method recalculates the lease view's total cost if the line cost on any of its payment schedule lines changes. This change can happen due to many reasons such as modifing the line cost, adding a new schedule, deleting an existing schedule, etc.

Returns:

Throws:

MXException

java.rmi.RemoteException

setRentalReadOnlyFields

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

Sets some fields to read only if the contract type is rental

Throws:

MXException

java.rmi.RemoteException

copyAssetsToContractAsset

public void copyAssetsToContractAsset(AssetSetRemote assetSetRemote)
                               throws MXException,
                                      java.rmi.RemoteException

Copies the selected Asset values to the CONTRACTASSET.

Specified by:

copyAssetsToContractAsset in interface LeaseViewRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

psdi.app.contract.lease

canAddAssetToContractAsset

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

Method to check if a row can be added to the associated assets tab. A row cannot be added if the contract is not approved.

Specified by:

canAddAssetToContractAsset in interface LeaseViewRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

psdi.app.contract.lease

canPurchaseOrReturnAsset

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

Can perform "Purchase" or "Return" assets "End Lease" actions for approved contracts only

Specified by:

canPurchaseOrReturnAsset in interface LeaseViewRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

psdi.app.contract.lease.ITSMELeaseView#canPurchaseOrReturnAsset

createEndLeaseInvoice

public void createEndLeaseInvoice(java.lang.String invNumber,
                                  java.lang.String targetStatus,
                                  MboSetRemote assetSet,
                                  boolean purchaseFlag)
                           throws MXException,
                                  java.rmi.RemoteException

Create invoice for purchase assets belonging to a lease contract (Lease End action).

Specified by:

createEndLeaseInvoice in interface LeaseViewRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

psdi.app.contract.lease.ITSMELeaseView#createEndLeaseInvoice

createEndLeasePO

public void createEndLeasePO(java.lang.String poNumber,
                             java.lang.String targetStatus,
                             MboSetRemote assetSet,
                             boolean purchaseFlag)
                      throws MXException,
                             java.rmi.RemoteException

Specified by:

createEndLeasePO in interface LeaseViewRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

psdi.app.contract.lease.ITSMELeaseView#createEndLeasePO

applyPriceAdjustment

public void applyPriceAdjustment(MboSetRemote contractLineSetRemote)
                          throws MXException,
                                 java.rmi.RemoteException

Specified by:

applyPriceAdjustment in interface LeaseViewRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

psdi.app.contract.lease.ITSMELeaseView#applyPriceAdjustment

applyPriceToLines

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

Apply the adjusted prices to the linecost of the contractLine.

Specified by:

applyPriceToLines in interface LeaseViewRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

applyPriceToLines()

reviseContract

public MboRemote reviseContract(java.lang.String revDescription)
                         throws MXException,
                                java.rmi.RemoteException

Creates a new revision of the current contract.

1. The new contract has the same contract number as the old contract.
2. The new contract has a new revision number.
3. When status of the new contract would be set to PENDING REVISION. The status of the old revision will remain APPROVED.
4. When the new revision is approved the status of the old revision will be set to REVISED.

Specified by:

reviseContract in interface ContractRemote

Specified by:

reviseContract in interface LeaseViewRemote

Overrides:

reviseContract in class Contract

Returns:

Returns the newly created contract revision reference.

Throws:

MXException

java.rmi.RemoteException

See Also:

canReviseContract

changeStatus

public void changeStatus(java.lang.String status,
                         java.util.Date date,
                         java.lang.String memo,
                         long accessModifier)
                  throws MXException,
                         java.rmi.RemoteException

Description copied from class: Contract

This method is overridden to add a wrapper to exceptions thrown during change status and to write warnings whether or not the status change is successful

Specified by:

changeStatus in interface StatefulMboRemote

Overrides:

changeStatus in class Contract

Parameters:

status - The new desired status. This is the translated status (that is, the status code as it would have been entered by a user, or valuelist.value), not the internal status value (valuelist.maxvalue).

date - The effective date of the new status (java.util.Date). If null the current date/time is used.

memo - A string briefly describing the circumstances of the change. The memo can be null.

accessModifier - A value of NOACCESSCHECK will cause the method not to call canChangeStatus. Callers using this flag are responsible for ensuring that they are attempting a valid status change.

Throws:

MXException - Thrown if there is a problem.

java.rmi.RemoteException

See Also:

StatefulMbo.canChangeStatus(String)

cancelInvoices

public void cancelInvoices(MboSetRemote assetSet)
                    throws MXException,
                           java.rmi.RemoteException

Cancel all the unpaid invoices which were created for the passed in assets. All invoices which were not approved, paid or already cancelled will be affected.

Specified by:

cancelInvoices in interface LeaseViewRemote

Parameters:

assetSet -

Throws:

MXException

java.rmi.RemoteException

See Also:

cancelInvoices(psdi.mbo.MboSetRemote)