psdi.app.financial

Class FinancialService

java.lang.Object

psdi.server.AppService

psdi.app.financial.FinancialService

All Implemented Interfaces:

java.rmi.Remote, FinancialServiceRemote, MboServerInterface, MaxRemoteProxy, AppServiceRemote, Dependable, Service, ServiceRemote, FixedLoggerNames, FixedLoggers

public class FinancialService
extends AppService
implements FinancialServiceRemote

Mbo object to represent FinancialService.

Author:

Aman Thakur

Field Summary

Fields inherited from interface psdi.util.logging.FixedLoggers

APPLOGGER, CRONTASKLOGGER, CRONTASKMGRLOGGER, CRONTASKMGRSQLLOGGER, DBCONNECTIONLOGGER, DDLOGGER, DMLOGGER, EVENTLOGGER, EXCEPTIONLOGGER, MAILLOGGER, MAXIMOLOGGER, MTLOGGER, NULLMBOPOINTER, SECURITY, SENDFAILEDLOGGER, SERVICELOGGER, SQLLOGGER

Fields inherited from interface psdi.util.logging.FixedLoggerNames

appenderPrefix, LOGGERNAME_APP, LOGGERNAME_CRONTASK, LOGGERNAME_CRONTASKMGR, LOGGERNAME_DBCONNECTION, LOGGERNAME_DD, LOGGERNAME_DM, LOGGERNAME_DMPREVIEW, LOGGERNAME_EVENT, LOGGERNAME_EXCEPTION, LOGGERNAME_MAIL, LOGGERNAME_MAXIMO, LOGGERNAME_MT, LOGGERNAME_NULLMBOPOINTER, LOGGERNAME_SECURITY, LOGGERNAME_SENDFAILED, LOGGERNAME_SERVICE, LOGGERNAME_SQL, LOGGERNAME_SQL_CRONTASKMGR, LOGGERNAME_TXN, loggerPrefix

Constructor Summary

Constructors

Constructor and Description
FinancialService() Construct the FinancialService object.
FinancialService(MXServer mxServer) Construct the FinancialService object.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAccountDefaults(UserInfo user, java.lang.String defaultGroup, java.lang.String orgID) Gets the GL Account default from ACCOUNTDEFAULTS that are tied to specific columns in the database.
java.lang.String	getAccountDefaults(UserInfo user, java.lang.String defaultGroup, java.lang.String groupValue, java.lang.String orgID) Gets the GL Account default from ACCOUNTDEFAULTS that are tied to specific columns in the database.
java.lang.String	getActiveFinancialPeriod(UserInfo user, java.util.Date transDate, java.lang.String orgID) Gets an active Financial Period, if transaction date is not between periodstart and periodend, use where transaction date < periodend and (current date < periodclosedate or periodclosedate is null).
java.util.Vector	getActiveFinancialPeriodInfo(UserInfo user, java.util.Date transDate, java.lang.String orgID) This method returns a vector of the derived financial period and it's related mbo remote.
int	getAddTaxIndcr(UserInfo user, java.lang.String typeCode, java.lang.String orgID, MboRemote mbo) Get the add tax indicator using typecode.
boolean[]	getIncludeTax(UserInfo user, java.lang.String typeCode, java.lang.String orgID, MboRemote mbo) Get the INCLUDETAX1 thru INCLUDETAX5 using typecode.
java.lang.String	getSpecificFinancialPeriod(UserInfo user, java.util.Date transDate, java.lang.String orgID) Gets a specific Financial Period if transaction date is between periodstart and periodend and (current date <= periodclosedate or periodclosedate is null).
double	getTaxRate(UserInfo user, java.lang.String typeCode, java.lang.String taxCode, java.lang.String orgID) Gets the tax rate using a combination of taxcode and typecode.
MboSetRemote	getTaxSet(UserInfo user, java.lang.String typeCode, java.lang.String taxCode, java.lang.String orgID, MboRemote mbo) Get Tax MboSetRemote using typecode and taxcode.
MboSetRemote	getTaxTypeSet(UserInfo user, java.lang.String typeCode, java.lang.String orgID, MboRemote mbo) Get TaxType MboSetRemote using typecode.
boolean	glRequiredForTrans(UserInfo user, java.lang.String orgID) Validate if the GL Account is required for transactions.
boolean	isFullySpecified(UserInfo user, java.lang.String account, java.lang.String orgID) This method is to check if the GL account has all the components filled in or specified.
void	setGLDefaultDescription(MboRemote chartOfAccount) Create a description for a GL Account based on its component descriptions.
void	update(UserInfo user, java.lang.String updateDBCriteria, java.lang.String orgID) This method is called when using the action Update Database in Chart of Accounts application.
boolean	validateFullGLAccount(UserInfo user, java.lang.String account, java.lang.String orgID) Validate if the GL Account is fully specified.
boolean	validatePartialGLAccount(UserInfo user, java.lang.String account, java.lang.String orgID) Validate if the GL Account is partially specified.
boolean	validateTax(UserInfo user, java.lang.String typeCode, java.lang.String taxCode, java.lang.String orgID) Validate a tax using a combination of typecode and taxcode.

Methods inherited from class psdi.server.AppService

checkSecurity, configure, destroy, freeDBConnection, freeMboSet, getCriteria, getCurrentState, getDBConnection, getLiveObjCount, getLoad, getMaximoDD, getMaxVar, getMboSet, getMXServer, getName, getProfile, getProxy, getSchemaOwner, getServiceInfo, getServiceLogger, getSetForRelationship, getSetFromKeys, getStateCmdList, getStateList, getURL, init, initCriteriaList, isAppService, isRunning, isSingletonService, restart, setProxy, setRunning, setURL, verifyUser, verifyUser

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface psdi.server.AppServiceRemote

checkSecurity, getCriteria, getCurrentState, getLiveObjCount, getMboSet, getName, getSchemaOwner, getSetForRelationship, getSetFromKeys, getStateCmdList, getStateList, getURL, verifyUser, verifyUser

Methods inherited from interface psdi.server.ServiceRemote

isAppService, isSingletonService, restart

Constructor Detail

FinancialService

public FinancialService()
                 throws java.rmi.RemoteException

Construct the FinancialService object.

Throws:

java.rmi.RemoteException

FinancialService

public FinancialService(MXServer mxServer)
                 throws java.rmi.RemoteException

Construct the FinancialService object.

Parameters:

mxServer -

Throws:

java.rmi.RemoteException

Method Detail

validateFullGLAccount

public boolean validateFullGLAccount(UserInfo user,
                            java.lang.String account,
                            java.lang.String orgID)
                              throws MXException,
                                     java.rmi.RemoteException

Validate if the GL Account is fully specified. If the maxvar DISABLEGLSWITCH is true no validation needs to be done. If the account has to be validated check the maxvar GLCHECKCOA. If GLCHECKCOA is true the GL Account needs to be validated against an exact match from CHARTOFACCOUNTS else the individual segments should be valid segments in GLCOMPONENTS.

Specified by:

validateFullGLAccount in interface FinancialServiceRemote

Parameters:

user - UserInfo object to get the user.

account - GL Account to be validated.

orgID - The organization identifier.

Returns:

boolean Indicates if the GL account is valid or not.

Throws:

MXException

java.rmi.RemoteException

See Also:

validateFullGLAccount(psdi.security.UserInfo, java.lang.String, java.lang.String)

validatePartialGLAccount

public boolean validatePartialGLAccount(UserInfo user,
                               java.lang.String account,
                               java.lang.String orgID)
                                 throws MXException,
                                        java.rmi.RemoteException

Validate if the GL Account is partially specified. If the maxvar DISABLEGLSWITCH is true no validation needs to be done. If the account has to be validated check the maxvar GLCHECKCOA. If GLCHECKCOA is true the GL Account needs to validated against CHARTOFACCOUNTS else the individual segments should be valid segments in GLCOMPONENTS.

Specified by:

validatePartialGLAccount in interface FinancialServiceRemote

Parameters:

user - UserInfo object to get the user.

account - GL Account to be validated.

orgID - The organization identifier.

Returns:

boolean Indicates if the GL account is valid or not.

Throws:

MXException

java.rmi.RemoteException

See Also:

validatePartialGLAccount(psdi.security.UserInfo, java.lang.String, java.lang.String)

getSpecificFinancialPeriod

public java.lang.String getSpecificFinancialPeriod(UserInfo user,
                                          java.util.Date transDate,
                                          java.lang.String orgID)
                                            throws MXException,
                                                   java.rmi.RemoteException

Gets a specific Financial Period if transaction date is between periodstart and periodend and (current date <= periodclosedate or periodclosedate is null). If the financial period has to be validated and there is none found, throw exception.

Specified by:

getSpecificFinancialPeriod in interface FinancialServiceRemote

Parameters:

user - UserInfo object to get the user.

transDate - Date on which the transaction occurs.

orgID - The organization identifier.

Returns:

String The financial period.

Throws:

MXApplicationException - (financial, invalidfinperiod) The financial period for this transaction is invalid.

MXException

java.rmi.RemoteException

See Also:

getSpecificFinancialPeriod(psdi.security.UserInfo, java.util.Date, java.lang.String)

getActiveFinancialPeriod

public java.lang.String getActiveFinancialPeriod(UserInfo user,
                                        java.util.Date transDate,
                                        java.lang.String orgID)
                                          throws MXException,
                                                 java.rmi.RemoteException

Gets an active Financial Period, if transaction date is not between periodstart and periodend, use where transaction date < periodend and (current date < periodclosedate or periodclosedate is null).

Specified by:

getActiveFinancialPeriod in interface FinancialServiceRemote

Parameters:

user - UserInfo object to get the user.

transDate - Date on which the transaction occurs.

orgID - The organization identifier.

Returns:

String The financial period.

Throws:

MXApplicationException - (financial, invalidfinperiod) The financial period for this transaction is invalid.

MXApplicationException - (financial, closedfinperiod) The financial period for this date is closed.

MXException

java.rmi.RemoteException

See Also:

getActiveFinancialPeriod(psdi.security.UserInfo, java.util.Date, java.lang.String)

getAccountDefaults

public java.lang.String getAccountDefaults(UserInfo user,
                                  java.lang.String defaultGroup,
                                  java.lang.String groupValue,
                                  java.lang.String orgID)
                                    throws MXException,
                                           java.rmi.RemoteException

Gets the GL Account default from ACCOUNTDEFAULTS that are tied to specific columns in the database.

The type of accounts or resource codes passed for the method parameter defaultGroup are:

• EXLABREC - External Labor control Accounts Default accounts are set up by the external labor's vendor e.g. BEARING, BURSAW, etc;
• LABRESCODE - Labor Resource Code You can set up one resource code for inside labor (Outside=N) and one for external labor (Outside=Y).
• TOOLRESCODE - Tool Resource Codes You can set up one resource code for internal tools (Outside=N) and one for external tools (Outside=Y).
• INVRESCODE - Inventory Resource Codes You can set up inventory resource codes by item type e.g. BELTS, FITTINGS, MOTOR, etc;

The values passed for the second parameter dfltgroup can be BELTS, MOTOR (stock type) for INVRESCODE.

see AccountDefaults for details on these default accounts.

Specified by:

getAccountDefaults in interface FinancialServiceRemote

Parameters:

user - UserInfo object to get the user.

groupValue -

defaultGroup -

orgID -

Returns:

String The default account.

Throws:

MXException

java.rmi.RemoteException

See Also:

getAccountDefaults(UserInfo, String, String)

getAccountDefaults

public java.lang.String getAccountDefaults(UserInfo user,
                                  java.lang.String defaultGroup,
                                  java.lang.String orgID)
                                    throws MXException,
                                           java.rmi.RemoteException

Gets the GL Account default from ACCOUNTDEFAULTS that are tied to specific columns in the database. The method takes two parameters: user(UserInfo) and dfltgroup (groupvalue is not needed). One example of use is when internal labor usage on work order is reported. As this is a case of internal labor being used there is no groupvalue.

Specified by:

getAccountDefaults in interface FinancialServiceRemote

Parameters:

user - UserInfo object to get the user.

groupValue -

defaultGroup -

orgID -

Returns:

String The default account.

Throws:

MXException

java.rmi.RemoteException

See Also:

psdi.app.financial.FinancialService#getAccountDefaults(UserInfo, String)

validateTax

public boolean validateTax(UserInfo user,
                  java.lang.String typeCode,
                  java.lang.String taxCode,
                  java.lang.String orgID)
                    throws MXException,
                           java.rmi.RemoteException

Validate a tax using a combination of typecode and taxcode.

Specified by:

validateTax in interface FinancialServiceRemote

Parameters:

user - UserInfo object to get the user.

typeCode - The tax type.

taxCode - The tax code to be validated.

orgID - The organization identifier.

Returns:

boolean Indicates if the tax is valid or not.

Throws:

MXException

java.rmi.RemoteException

See Also:

validateTax(psdi.security.UserInfo, java.lang.String, java.lang.String, java.lang.String)

getTaxRate

public double getTaxRate(UserInfo user,
                java.lang.String typeCode,
                java.lang.String taxCode,
                java.lang.String orgID)
                  throws MXException,
                         java.rmi.RemoteException

Gets the tax rate using a combination of taxcode and typecode.

Specified by:

getTaxRate in interface FinancialServiceRemote

Parameters:

user - UserInfo object to get the user.

taxCode - The tax code.

typeCode - The tax type.

orgID - The organization identifier.

Returns:

double The tax rate for this tax code.

Throws:

MXException

java.rmi.RemoteException

See Also:

getTaxRate(psdi.security.UserInfo, java.lang.String, java.lang.String, java.lang.String)

getAddTaxIndcr

public int getAddTaxIndcr(UserInfo user,
                 java.lang.String typeCode,
                 java.lang.String orgID,
                 MboRemote mbo)
                   throws MXException,
                          java.rmi.RemoteException

Get the add tax indicator using typecode. The add tax indicator indicates if tax is added to the cost of line items when invoicing.

Specified by:

getAddTaxIndcr in interface FinancialServiceRemote

Parameters:

user - UserInfo object to get the user.

typeCode - The tax type.

orgID - The organization identifier.

mbo - The passed in mbo remote.

Returns:

int Add tax indicator.

Throws:

MXException

java.rmi.RemoteException

See Also:

getAddTaxIndcr(psdi.security.UserInfo, java.lang.String, java.lang.String, psdi.mbo.MboRemote)

getIncludeTax

public boolean[] getIncludeTax(UserInfo user,
                      java.lang.String typeCode,
                      java.lang.String orgID,
                      MboRemote mbo)
                        throws MXException,
                               java.rmi.RemoteException

Get the INCLUDETAX1 thru INCLUDETAX5 using typecode.

Specified by:

getIncludeTax in interface FinancialServiceRemote

Parameters:

user - UserInfo object to get the user.

typeCode - The tax type.

orgID - The organization identifier.

mbo - The passed in mbo remote.

Returns:

boolean[] Returns an array of booleans storing the includetax1-5 values.

Throws:

MXException

java.rmi.RemoteException

See Also:

getIncludeTax(psdi.security.UserInfo, java.lang.String, java.lang.String, psdi.mbo.MboRemote)

getTaxTypeSet

public MboSetRemote getTaxTypeSet(UserInfo user,
                         java.lang.String typeCode,
                         java.lang.String orgID,
                         MboRemote mbo)
                           throws MXException,
                                  java.rmi.RemoteException

Get TaxType MboSetRemote using typecode.

Specified by:

getTaxTypeSet in interface FinancialServiceRemote

Parameters:

user - UserInfo object to get the user.

typeCode - The tax type.

orgID - The organization identifier.

mbo - The passed in mbo remote.

Returns:

MboSetRemote The TaxType MboSetRemote for the passed in taxtype.

Throws:

MXException

java.rmi.RemoteException

See Also:

getTaxTypeSet(psdi.security.UserInfo, java.lang.String, java.lang.String, psdi.mbo.MboRemote)

getTaxSet

public MboSetRemote getTaxSet(UserInfo user,
                     java.lang.String typeCode,
                     java.lang.String taxCode,
                     java.lang.String orgID,
                     MboRemote mbo)
                       throws MXException,
                              java.rmi.RemoteException

Get Tax MboSetRemote using typecode and taxcode.

Specified by:

getTaxSet in interface FinancialServiceRemote

Parameters:

user - UserInfo object to get the user.

typeCode - The tax type.

taxCode - The tax code.

orgID - The organization identifier.

mbo - The passed in mbo remote.

Returns:

MboSetRemote The Tax MboSetRemote.

Throws:

MXException

java.rmi.RemoteException

See Also:

getTaxSet(psdi.security.UserInfo, java.lang.String, java.lang.String, java.lang.String, psdi.mbo.MboRemote)

isFullySpecified

public boolean isFullySpecified(UserInfo user,
                       java.lang.String account,
                       java.lang.String orgID)
                         throws MXException,
                                java.rmi.RemoteException

This method is to check if the GL account has all the components filled in or specified. This can be used if you are validating a partial GL account but all the components may be specified. The validation of a partial GL account is different based on whether all the components are filled in or not. Returns true if the account has all the components specified.

Specified by:

isFullySpecified in interface FinancialServiceRemote

Parameters:

UserInfo - user UserInfo object to get the user.

String - account The GL account string.

Returns:

boolean Indicates if the GL account is fully specified.

Throws:

MXException

java.rmi.RemoteException

See Also:

isFullySpecified(psdi.security.UserInfo, java.lang.String, java.lang.String)

update

public void update(UserInfo user,
          java.lang.String updateDBCriteria,
          java.lang.String orgID)
            throws MXException,
                   java.rmi.RemoteException

This method is called when using the action Update Database in Chart of Accounts application. This action page displays a group of three radio buttons based on whose selection some database updates are done. The updates will be done based on changes made to accounts in tables ACCOUNDEFAULTS, COMPANYACCDEF and LOCATIONS. There are three update database criterias handled by three radio buttons: BLANKACCOUNTS - Overwrite Blank Accounts Only. Choose this option if you want the updated Chart of Accounts data to overwrite only those affected MAXIMO GL Account fields that are currently blank. For example, if you created a new account code for an existing item type's GL account field, choosing this option would overwrite only the item's GL Account field where it is blank, but not where a GL account has already been entered. OLDDEFACCOUNTS - Overwrite Accounts With Old Defaults. Choose this option if you want the updated Chart of Accounts data to overwrite GL account fields that still have the previous GL account. For example, suppose an item type had a GL account code associated with it in Chart of Accounts. This account code was inserted on item records where the item type was involved. On some records, the account code was subsequently changed to another one. Choosing the Overwrite Accounts With Old Defaults option will not update those records in which the account code was subsequently changed. ALLACCOUNTS - Overwrite All Accounts. Choose this option if you want the modified Chart of Accounts data to overwrite all relevant GL Account fields in MAXIMO records. For example, if an item type has a GL account code associated with it in Chart of Accounts, choosing this option will fill in blank GL Account fields for that item type and overwrite all existing GL Account fields for items of that type, including ones that were subsequently changed. NOTE: Historical records will not be updated. Make sure that no one is currently using MAXIMO when you update the database.

Specified by:

update in interface FinancialServiceRemote

Parameters:

user - The user info.

updateDatabase - The criteria used for the update.

orgID - The organization identifier.

Throws:

MXException

java.rmi.RemoteException

See Also:

update(psdi.security.UserInfo, java.lang.String, java.lang.String)

glRequiredForTrans

public boolean glRequiredForTrans(UserInfo user,
                         java.lang.String orgID)
                           throws MXException,
                                  java.rmi.RemoteException

Validate if the GL Account is required for transactions. If the maxvar GLREQUIREDFORTRANS is true validation needs to be done.

Specified by:

glRequiredForTrans in interface FinancialServiceRemote

Parameters:

user - UserInfo object to get the user.

orgID - The organization identifier.

Returns:

boolean Indicates if the GL account is valid or not.

Throws:

MXException

java.rmi.RemoteException

See Also:

glRequiredForTrans(psdi.security.UserInfo, java.lang.String)

setGLDefaultDescription

public void setGLDefaultDescription(MboRemote chartOfAccount)
                             throws MXException,
                                    java.rmi.RemoteException

Create a description for a GL Account based on its component descriptions. The description includes " + " between each segment. Blank segments are skipped. If the GLCOMPONENT and CHARTOFACCOUNTS tables are enabled for multi-language, descriptions are created for all enabled languages. If translated values are not available for all components, the components without translations are displayed in the base language. If no value is available in the translated language or base language, the segment is skipped.

Specified by:

setGLDefaultDescription in interface FinancialServiceRemote

Parameters:

chartOfAccount - Chart of accounts MboRemote.

Throws:

MXException

java.rmi.RemoteException

See Also:

setGLDefaultDescription(psdi.mbo.MboRemote)

getActiveFinancialPeriodInfo

public java.util.Vector getActiveFinancialPeriodInfo(UserInfo user,
                                            java.util.Date transDate,
                                            java.lang.String orgID)
                                              throws MXException,
                                                     java.rmi.RemoteException

This method returns a vector of the derived financial period and it's related mbo remote. Currently it is only used by invoice which needs to get the financial period start date if the current period is closed and the user chooses to use the next period.

Specified by:

getActiveFinancialPeriodInfo in interface FinancialServiceRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

getActiveFinancialPeriodInfo(psdi.security.UserInfo, java.util.Date, java.lang.String)