psdi.app.financial

Class FinControl

java.lang.Object

psdi.mbo.Mbo

psdi.app.financial.FinControl

All Implemented Interfaces:

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

public class FinControl
extends Mbo
implements FinControlRemote

Mbo object to represent FinCntrl. FinControl(FinCntrl) object represents the financial entities that will primarily be imported from the external system. The financial entity will be identified by the attribute FINCNTRLID. The ability to reference this FINCNTRLID will be provided on the workorder application. All MAXIMO applications where a workorder or a GL debit account can be specified, will include the ability specify a FINCNTRLID.

See Financial Package description.

This is an organization/site level object.

The key attributes for this object are OrgId and FinCntrlID.

The attributes in this object are as follows:

Attribute Name	Description
ActualCost	Actual amount.
AllocatedCost	Allocated cost.
AsOfDate	Date last reported.
BudgetCost	Budgeted Amount.
BudgetID	Budget Identifier.
BudgetLineID	Budget Line Identifier.
BudgetLineType	Budget line type.
BudgetType	Budget type.
BurdenedCost	Burdened Amount.
ChangeBy	The name or user ID of the person who last modified the financial control entity.
ChangeDate	The date and time when financial control entity was last modified.
CommittedCost	Committed Amount.
Description	Description of the financial control entity.
Disabled	Indicates whether the financial control entity has been disabled from use.
EndDate	Effective finish date for the financial control entity.
FCStatus	Status of the financial control entity.
FCType	Financial control type.
IsChargeAble	Indicates whether costs can be collected for this cost entity.
IsSummary	Indicates whether this is a summary reporting cost entity.
LDKey	Long Description Key. This is a link to text stored in the LongDescription table.
OrgId	Identifier of the organization for this financial control entity.
OwnerSysID	Application system managing the financial control entity.
FldFinControlParentFCID	Parent Financial Control Identifier.
ParentProjectID	Non-persistent attribute which stores the parent projectid for this financial control entity.
ParentTaskID	Non-persistent attribute which stores the parent taskid for this financial control entity.
ProjectID	Project Identifier.
ProjectType	Project type.
RemainingCost	Remaining Amount.
SenderSysID	Column used by ERP-Integration (APIs).
SiteId	Identifier of the site for this financial control entity.
SourceID	Source Identifier.
SourceSysID	Souce application system for this financial control entity.
StartDate	Effective start date for the financial control entity.
TaskID	Task Identifier.
TaskLevel	Level from the top in a parent-child task-subtask relationship.
TaskType	Task type.
TemplateID	Template Identifier.

Author:

Aman Thakur

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

Method Summary

Methods

Modifier and Type	Method and Description
void	add() This is called when a new financial control identifier is added to the FinControl MboSet collection.
void	appValidate() This method is called by the framework before save.
void	canDelete() This method will be called before the actual deletion of the mbos.
void	checkChildren(MboRemote fcMbo) Since cost management has a hierarchy which can be several levels deep, we have to check if any of the children's fincntrlid is the same as the parentfincntrlid which is being set.
void	delete(long accessModifier) Deleting a Project will result in all the Tasks for that Project being deleted.
void	generateAutoKey() Financial Control supports autokeying - sets the FINCNTRLID attribute.
java.lang.String[]	getValidateOrder() Override the system method.
void	init() Initialize rountine.
void	modify() This is called whenever a change is made to the attributes of FinControl.

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, generateContentUID, getAlwaysFlags, getAttrRestrictionFlag, getAttrRestrictions, getBoolean, getByte, getBytes, getCheckpoint, getClientLocale, getClientTimeZone, getCommLogOwnerNameAndUniqueId, getCondition, getDatabaseValue, getDate, getDeleteForInsertList, getDocLinksCount, getDomainFilterWhere, getDomainIDs, getDouble, getExistingMboSet, getFetchIndex, getFieldExceptions, getFlags, getFloat, getIgnoreLockCheck, getInitialValue, getInsertCompanySetId, getInsertItemSetId, getInsertOrganization, getInsertSite, getInstanciatedMboSet, getInstanciatedMboValue, getInt, getIntegrationService, getKeyValue, getLanguageRecordRowStamp, getLinesRelationship, getList, getLockedByDisplayName, getLockedByUserID, getLong, getMatchingAttr, getMatchingAttr, getMatchingAttrs, getMaxMessage, getMboData, getMboDataSet, getMboForAttribute, getMboForAttributeStatic, getMboInitialValue, getMboList, getMboLogger, getMboRecordData, getMboServer, getMboSet, getMboSet, getMboSet, getMboSetInfo, getMboValue, getMboValueData, getMboValueData, getMboValueData, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getProfile, getPropagateKeyFlag, getProxy, getRecordIdentifer, getRecordMboName, getRelatedWhere, getRelatedWhere, getRelationshipNameToLangTable, getRowRestrictionFlag, getRowStamp, getSecurityLogger, getSiteOrg, getSqlLogger, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getSynonymValueWhere, getTenantId, getThisMboSet, getTranslator, getUniqueIdentifer, getUniqueIDName, getUniqueIDValue, getUserInfo, getUserName, hasFieldAccess, hasHierarchyLink, hasLockSaveRights, hasRelatedQbe, hasUniqueID, initFieldFlagsOnMbo, initRelationship, isAutoKeyed, isBasedOn, isChangeByUserWhenSetFromLookup, isEAuditFieldModified, isESigFieldModified, isFlagSet, isForDM, isLocked, isLocked, isLockedByMe, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNull, isOptionGranted, isSelected, isSkipCopyField, isValid, isZombie, lock, moveFieldFlagsToMboValue, needCallInitFieldFlag, orEvaluateConditions, propagateKeyValue, removeRelatedSet, rollbackToCheckpoint, select, setAppDefaultValue, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDefaultValue, setDefaultValues, setDeleted, setEAuditFieldModified, setESigFieldModified, setFetchIndex, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlags, setFlag, setFlag, setFlags, setForDM, setHierarchyLink, setIgnoreRecordLockCheck, setLangCodeDefault, setMLValue, setModified, setNewMbo, setPropagateKeyFlag, setPropagateKeyFlag, setProxy, setReadonlyWhenParentIsReadonly, setReferencedMbo, setReferencedMbo, 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.mbo.MboRemote

addMboSetForRequiredCheck, addToDeleteForInsertList, blindCopy, checkMethodAccess, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, 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, 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

FinControl

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

Construct the FinControl object

Throws:

java.rmi.RemoteException

Method Detail

init

public void init()
          throws MXException

Initialize rountine. Set certain fields to read/only according to the mbo's state.

Overrides:

init in class Mbo

Throws:

MXException

add

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

This is called when a new financial control identifier is added to the FinControl MboSet collection. The field defaults and field flags are set here. The fincntrlid is auto keyed. The table below shows the default values for each of the attributes listed.

Attribute Name	Attribute Value
actualcost	0.0(zero)
changeby	Current username
changedate	Current date
disabled	No
fcstatus	APPR
fctype	PROJECT/TASK
ischargeable	Yes
issummary	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 FinControl. When any field is changed, changedate and changeby is updated.

Overrides:

modify in class Mbo

Throws:

MXException

java.rmi.RemoteException

generateAutoKey

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

Financial Control supports autokeying - sets the FINCNTRLID attribute. This method is only to be called when we are enforcing autokeying the fincntrlid attribute. Only autokey if the attribute is null as it may already be autokeyed by the framework. Only allowed for newly created financial control entity.

Specified by:

generateAutoKey in interface MboRemote

Overrides:

generateAutoKey in class Mbo

Throws:

MXAccessException - (access, CantGenAutoKey) Cannot generate auto key.

java.rmi.RemoteException

MXException

See Also:

MboValue.autoKey(), MboValue.generateUniqueID()

canDelete

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

This method will be called before the actual deletion of the mbos. A Project cannot be deleted if there are any child Projects specified for the given Project. If there are no child Projects, deleting a Project will result in all the Tasks for that Project being deleted. If a Task within a Project is deleted, the delete will not be allowed if there are any child Tasks specified for that Task. If the Task has no children, it can be deleted.

Overrides:

canDelete in class Mbo

Throws:

MXApplicationException - (financial, CannotDeleteParentProject) Cannot delete a parent project.

MXApplicationException - (financial, CannotDeleteParentTask) Cannot delete a parent task.

MXException

java.rmi.RemoteException

delete

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

Deleting a Project will result in all the Tasks for that Project being deleted. If a Task within a Project is deleted, the delete will not be allowed if there are any child Tasks specified for that Task. If the Task has no children, it can 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)

appValidate

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

This method is called by the framework before save. Checks to make sure that all required combinations of projectid and taskid are there before saving. Also checks for any duplicates.

Overrides:

appValidate in class Mbo

Throws:

MXApplicationException - (financial, ProjectRequired) Project is required.

MXApplicationException - (financial, TaskRequired) Task is required.

MXApplicationException - (financial, DuplicateTask) The Task already exists.

MXException

java.rmi.RemoteException

checkChildren

public void checkChildren(MboRemote fcMbo)
                   throws MXException,
                          java.rmi.RemoteException

Since cost management has a hierarchy which can be several levels deep, we have to check if any of the children's fincntrlid is the same as the parentfincntrlid which is being set. Basically we have to make sure that the parent does not exist as a child to the current Task or Project some where below in the hierarchy.

Parameters:

MboRemote - fcMbo The financial control mbo whose children are to be checked.

Throws:

MXApplicationException - (financial, CannotUseAsParent) Cannot use child as parent.

MXException

java.rmi.RemoteException

getValidateOrder

public java.lang.String[] getValidateOrder()

Override the system method. This method is called by the framework and returns an array of fields whose order need to be maintained during the delayed validation. This sequence is for maximizing performance for API and yielding correct result. The sequence should be: fincntrlid, fctype, parentfincntrlid, startdate, enddate, budgetid, budgetlineid, projectid, taskid, budgettype, budgetlinetype, projecttype, tasktype, parentprojectid, parenttaskid.

Overrides:

getValidateOrder in class Mbo

Returns:

String[] Array of fincontrol fields in the defined sequence.