package com.temenos.t24.api.hook.

accounting
/**
*The AccountHook component allows access to routines for raise overrides from
* a local development and export acccouting entries to local development and
returns
* local field values and local field names from local development.
* There are hooks for ACCOUNTING.SUBRTN, ACCT.NAU.SUBRTN and LOCAL.REF.SUBRTN in
ACCOUNT.PARAMETER.
*/
public class AccountingEntry {
/**
* This Interface enables the implementer to performs the check digit
calculation in local developement.<br>
* This interface is invoked account number entered for account creation within
T24.<br>
* <b>T24 details: </b> Interface method for the ACCT.CHECKDIG.TYPE field in
COMPANY in T24.
* The EB.API hook used by this interface is HOOK.COMPANY.ACCT.CHECK.DIGIT.TYPE.
* If an exception is thrown in the implementing class exception message will be
throwned in the screen.<br>
* Returns modified accountId after the check digit calculation.<br>
* @param applicationName String : Name of the application<br>
* @param currentVersionId String : Current version of the Id<br>
* @param idType String : Type of the Id generation.Example: "NEW"<br>
* @param checkDigitType String : Type of the check digits.Example: Forward-"F"
or BackWard-"B"<br>
* @param currentAccountId TString : Account number entered<br>
*/
public void setAccountId(String applicationName, String currentVersionId,
String idType, String checkDigitType, TString currentAccountId){}

/**
* This Interface enables the implementer for export accounting entries to local
developement.<br>
* This interface is invoked during the accounting phase of any transaction
within T24.<br>
* <b>T24 details: </b> Interface method for the ACCOUNTING.SUBRTN field in
ACCOUNT.PARAMETER in T24.
* The EB.API hook used by this interface is HOOK.ACCT.PARAM.ACCTNG.SUBRTN.
* If an exception is thrown in the implementing class exception message will be
logged in the EXCEPTION.LOG file.<br>
* Export accounting entries during the accounting phase of any transaction
within T24.<br>
* @param entryType String : Type of entry like STMT or CATG or CONSOL or
FWD.<br>
* @param actionType String : Action Type can be "VAL" for Input
Entries,"VALAUT", "ADD.AUT", "SAO".<br>
* @param statementId String : Id of the statement Entry.<br>
* @param accountingEntry
com.temenos.t24.api.records.stmtentry.StmtEntryRecord : The actual accounting
entries.<br>
*/
public void exportEntries(String entryType, String actionType, String
statementId, com.temenos.t24.api.records.stmtentry.StmtEntryRecord accountingEntry)
{}

/**
* This Interface enables the implementer to generate an alternate account
Id.<br/>
 * This interface is invoked during account or arrangement account validation
within T24.<br/>
* <b>T24 details: </b> The EB.API hook used by this interface is
ALT.ACCT.PARAM.ALT.ACCT.GEN.HOOK
* The T24 field specifying this hook is the ALT.ACCT.GEN.API field in
ALT.ACCT.PARAMETER.<br>
* If an exception is thrown in the implementing class a validation error will
be raised and the exception message will be displayed on the screen.<br/>
* <br>
* @param applicationName String : The name of the application being processed
(In T24 terms this is the APPLICATION common variable).<br>
* @param accountId String : The id of the account for which alternate account
needs to be generated.<br>
* @param accountRecord TStructure : The record is either an account or an
arrangement account record.<br>
* @param accountType String : Account type for the alternate account to be
generated. This is defaulted from ACCOUNT.PARAMETER table and is a valid
ALT.ACCT.PARAMETER id.<br>
* @param alternateAccountId String : The current value of the alternate account
Id if set .<br>
* @param alternateAccountContext
com.temenos.t24.api.complex.ac.accounthook.AlternateAccountContext : Context
relating to the operation including current record Id and function.<br>
* @return String : the alternate account Id.<br>
*/
public String getAlternateAccountId(String applicationName, String accountId,
TStructure accountRecord, String accountType, String alternateAccountId,
com.temenos.t24.api.complex.ac.accounthook.AlternateAccountContext
alternateAccountContext){}

/**
* This interface enables the implementer to generate an Integration event for a
Statement Entry<br>
* This interface is invoked during the accounting phase of any transaction
within T24 when a Statement Entry is raised.<br>
* <br/><b>T24 details: </b> The EB.API hook used by this interface is
HOOK.ACCT.PARAM.ACCTNG.SUBRTN.
* The T24 field specifying this hook is the ACCOUNTING.SUBROUTINE field in the
ACCOUNT.PARAMETER table.<br>
* If an exception is thrown in the implementing class, the exception message
will be logged in the EXCEPTION.LOG file and an event will not be raised.<br>
* @param applicationName TString : The name of the application for which the
event is to be generated. In T24 terms this is the APPLICATION common variable.
Will only be populated during template processing.<br>
* @param statementEntryId String : Id of the statement entry. In T24 terms this
is a valid id to the STMT.ENTRY table.<br>
* @param statementEntryRecord
com.temenos.t24.api.records.stmtentry.StmtEntryRecord : The statement entry.<br>
* @param accountContext
com.temenos.t24.api.complex.ac.accounthook.AccountContext : Context relating to the
accounting process.<br>
* @param nameValuePairs
List<com.temenos.t24.api.complex.ac.accounthook.NameValuePair> : Name value pairs
to add additional information to the eventCommon section of the IF event.<br>
* @param isEventRequired TBoolean : Indicates whether the Integration Event
should be generated. If this is false no integration event will be generated.<br>
*/
public void generateStatementEntryEvent(TString applicationName, String
statementEntryId, com.temenos.t24.api.records.stmtentry.StmtEntryRecord
statementEntryRecord, com.temenos.t24.api.complex.ac.accounthook.AccountContext
accountContext, List<com.temenos.t24.api.complex.ac.accounthook.NameValuePair>
nameValuePairs, TBoolean isEventRequired){}

/**
* This Interface enables the implementer post updates to records asynchronously
via OFS.MESSAGE.SERVICE during the accounting phase of a transaction
* and return modified accounting entry with local reference field values
attached as part of STMT.ENTRY/CATEG.ENTRY/SPEC.ENTRY table.<br>
* <br/><b>T24 Details:</b> The EB.API hook used by this interface is
HOOK.ACCT.PARAM.ACCTNG.SUBRTN.
* The T24 field specifying this hook is the ACCOUNTING.SUBRTN field in the
ACCOUNT.PARAMETER table.<br>
* This interface writes the request into the file OFS.MESSAGE.QUEUE. The
request will be processed when the OFS.MESSAGE.SERVICE service is run.
* Note that The versionId should not be a comma version in transaction data.
* If the OFS.SOURCE id specified in the transactionData is invalid then the
request will be ignored. <br>
* If an exception is thrown in the implementing class then an exception message
will be logged in the EXCEPTION.LOG file.<br>
* @param entryType String : The type of accounting entry.<ul> <li>STMT -
Records are stored in the STMT.ENTRY table.</li> <li>CATEG - Records are stored in
the CATEG.ENTRY table.</li> <li>CONSOL - Records are stored in the
RE.CONSOL.SPEC.ENTRY table.</li> <li>FWD - Records are stored in the STMT.ENTRY or
STMT.ENTRY.FWD tables.</li> </ul><br>
* @param actionType String : The action type indicates at which stage or under
which circumstances the statement entries were generated.<ul> <li>CHG: Change of
record.</li> <li>DEL: Deletion of record.</li> <li>VAL: Input of record.</li>
<li>VALAUT: Input & authorisation of record.</li> <li>REV: Reversal of authorised
record.</li> <li>SAO: Generated on override auto approval of record.</li> <li>SNP:
Generated when an override is encountered.</li> <li>SSS: Suspended customer account
entries generated when an override is encountered.</li> <li>RSAO: Generated on
reversal of record when overrides are auto approved.</li> <li>ADD: Input of record
with forward dated accounting .</li> <li>AUT: Authorisation of record.</li>
<li>ADD.AUT: Input & authorisation of record with forward dated accounting</li>
</ul><br>
* @param entryId String : Id of the statement entry. Statement entries exist in
different tables according to the entryType however most have the same structure
including the Julian date and time.<br>
* @param accountingEntry TStructure : The accounting entry.<br>
* @param application String : The name of the application to which the record
belongs. In T24 terms this is the APPLICATION common variable. Will only be
populated during template processing.<br>
* @param currentRecordId String : The id of the record being processed. In T24
terms this is the ID.NEW common variable. Will only be populated during template
processing .<br>
* @param currentRecord TStructure : The record being processed. In T24 terms
this is the R.NEW common variable. Will only be populated during template
processing.<br>
* @param accountingContext
com.temenos.t24.api.complex.ac.accounthook.AccountingContext : Transaction related
variables.<br>
* @param transactionData
List<com.temenos.t24.api.complex.eb.servicehook.TransactionData> : List of the
transaction data to post the request.<br>
* @param records List<TStructure> : A list of records for the data at the
corresponding index in transactionData.<br>
*/
public void postUpdateRequest(String entryType, String actionType, String
entryId, TStructure accountingEntry, String application, String currentRecordId,
TStructure currentRecord,
com.temenos.t24.api.complex.ac.accounthook.AccountingContext accountingContext,
List<com.temenos.t24.api.complex.eb.servicehook.TransactionData> transactionData,
List<TStructure> records){}

/**
* This Interface enables the implementer to raise any overrides from local
development.<br>
* This interface is invoked during the input phase of any transaction within
T24.It will accept accounting entries
* and returns overrides.<br>
* <b>T24 details: </b> Interface method for the ACCT.NAU.SUBRTN field in
ACCOUNT.PARAMETER in T24.
* The EB.API hook used by this interface is HOOK.ACCT.PARAM.ACCT.NAU.SUBRTN.
* If an exception is thrown in the implementing class exception message will be
logged in the EXCEPTION.LOG file.<br>
* <br>
* @param entryType String : Type of entry- like STMT or CATG.<br>
* @param actionType String : Action Type can be "VAL" for Input Entries.<br>
* @param forward String : Optional parameter can be "".<br>
* @param statementEntry com.temenos.t24.api.records.stmtentry.StmtEntryRecord :
Record of the statement entry id .<br>
* @return List<String> : a list of override messages at the input phase of any
transaction.<br>
*/
public List<String> raiseOverrides(String entryType, String actionType, String
forward, com.temenos.t24.api.records.stmtentry.StmtEntryRecord statementEntry){}

/**
* This Interface enables the implementer to generate an alternate account
Id.<br/>
* This interface is invoked during account or arrangement account creation
within T24.<br/>
* <b>T24 details: </b> Interface method for the ALT.ACCT.GEN.API field in
ALT.ACCT.PARAMETER in T24.
* The EB.API hook used by this interface is HOOK.ALT.ACCT.PARAM.ALT.ACCT.GEN.
* If an exception is thrown in the implementing class exception message will be
shown on the screen.<br/>
* <br>
* @return String : the alternate account Id.<br>
* @deprecated use AccountingEntry.getAlternateAccountId instead.<br>
*/
public String setAlternateAccountId(){}

/**
* This Interface enables the implementer to return values from local
development for the local fields attached as part of
STMT.ENTRY/CATEG.ENTRY/RE.CONSOL.SPEC.ENTRY table.<br>
* This interface is invoked during the input phase of any transaction within
T24.<br>
* <br/><b>T24 details: The EB.API hook used by this interface is
ACCT.PARAM.LOCAL.REF.SUBRTN.HOOK <br>
* The T24 field specifying this hook is the LOCAL.REF.SUBRTN field in the
ACCOUNT.PARAMETER table. <br>
* If an exception is thrown in the implementing class exception message will be
logged in the EXCEPTION.LOG file and process will continue without updating local
field values in the accounting entries <br>
* <br>
 * @param applicationId String : Application product. Eg: "FT", "MM", "LD".<br>
* @param actionType String : The action type indicates at which stage or under
which circumstances the statement entries were generated.<ul> <li>CHG: Change of
record.</li> <li>DEL: Deletion of record.</li> <li>VAL: Input of record.</li>
<li>VALAUT: Input & authorisation of record.</li> <li>REV: Reversal of authorised
record.</li> <li>SAO: Generated on override auto approval of record.</li> <li>SNP:
Generated when an override is encountered.</li> <li>SSS: Suspended customer account
entries generated when an override is encountered.</li> <li>RSAO: Generated on
reversal of record when overrides are auto approved.</li> <li>ADD: Input of record
with forward dated accounting .</li> <li>AUT: Authorisation of record.</li>
<li>ADD.AUT: Input & authorisation of record with forward dated accounting</li>
</ul><br>
* @param accountingEntry
com.temenos.t24.api.records.stmtentry.StmtEntryRecord : Accounting Entry<br>
* @param isForwardEntry String : This indicates whether the current statement
entry is a future processing dated accounting entry or not.<br>
* @param accountingContext
com.temenos.t24.api.complex.ac.accounthook.AccountingContext : Transaction related
variables. Not used now and reserved for future use.<br>
* @param localFieldDetails
List<com.temenos.t24.api.complex.ac.accounthook.LocalFieldDetails> : This contains
the local field name and local field value<br>
*/
public void getAccountingEntryLocalFieldValues(String applicationId, String
actionType, com.temenos.t24.api.records.stmtentry.StmtEntryRecord accountingEntry,
String isForwardEntry, com.temenos.t24.api.complex.ac.accounthook.AccountingContext
accountingContext,
List<com.temenos.t24.api.complex.ac.accounthook.LocalFieldDetails>
localFieldDetails){}