insert | insert | | Standard Operation | |
read | read | | Standard Operation | |
readSumUnprocessedAmtByCaseIDCreditDebitType | ns | | To calculate the sum of the unprocessedAmount field for one CreditDebitType for a Case. | SQL |
searchByCategoryStatusNomineeLink | nsmulti | | To get a list of instructionLineItem for a particular categoryCode and statusCode. | SQL |
searchByAdjustIndCategoryDateStatus | nsmulti | | To get a list of instructionLineItem for a particular categoryCode, effectiveDate, statusCode and adjustmentInd. | SQL |
modifyStatusFinInstructIDUnprocAmt | nsmodify | OPTIMISTIC_LOCKING: yes
| To update the statusCode, finInstructionID and unprocessedAmt fields for an instructionLineItem. | |
modifyStatusFinInstructID | nsmodify | OPTIMISTIC_LOCKING: yes
| To update the statusCode and finInstructionID fields for an instructionLineItem. | |
modifyNextAdjustmentDate | nsmodify | OPTIMISTIC_LOCKING: yes
| To update the nextAdjustmentDate for an instructionLineItem. | |
searchByCaseIDStatusCodeCreditDebitType | nsmulti | READMULTI_LIM: 0
| To retrieve all the Instruction Line Items for a particular Case of a certain status. | SQL |
modifyStatusUnprocessedAmt | nsmodify | OPTIMISTIC_LOCKING: yes
| To update the statusCode and unprocessedAmt on an instruction line item. | |
modifyStatusCode | nsmodify | OPTIMISTIC_LOCKING: yes
| To update the statusCode on an instruction line item. | |
modifyUnprocessedAmt | nsmodify | OPTIMISTIC_LOCKING: yes
| To update the unprocessedAmount on an instruction line item | |
searchByFinInstructStatus | nsreadmulti | | To retrieve all the Instruction Line Items for a particular financial instruction, of a certain status. | |
modifyFinInstructID | nsmodify | OPTIMISTIC_LOCKING: yes
| To update the financial instruction ID on an instruction line item record. | |
searchByFinInstructID | nsreadmulti | READMULTI_LIM: 300
| To get a list of Instruction Line Items that were combined into one Financial Instruction. | |
searchCreditAllocations | nsmulti | | To get information on the (debit) instruction line items to which the specified credit instruction line item is allocated. | SQL |
searchDebitAllocations | nsmulti | | To get information on the (credit) instruction line items to which the specified debit instruction line item is allocated. | SQL |
searchRelatedILIByRelatedLineItemIDType | nsmulti | | To get the summary of a related Instruction Line Item by specifying the relatedInstructionLineItemID and the relationship type. | SQL |
searchByCaseIDDateRange | nsmulti | READMULTI_LIM: 300
| To retrieve a subset of InstructionLineItems details for a specified CaseID & Date Range | SQL |
searchByConcernRoleIDCreditDebitTypeStatusCode | nsreadmulti | | To get a list of InstructionLineItems for a specified concernRoleID, statusCode and creditDebitType. | |
searchRelatedILIByInstrLineItemIDType | nsmulti | | To get the summary of a related Instruction Line Item by specifying the InstructionLineItemID and the relationship type. | SQL |
readLatestCoverPeriodTo | ns | | To retrieve the most recent coverPeriodTo date of a case. | SQL |
readNextCoverPeriodTo | ns | | To retrieve the next CoverPeriodTo date using the caseID of the case being processed and the change effective date from the re-assessment. | SQL |
readPreviousCoverPeriodFrom | ns | | To retrieve the coverPeriodTo date of a period using the CaseID and changeDate | SQL |
searchByCaseIDCoverPeriod | nsmulti | | Returns a list of instruction line items based on a specified case and cover period. This is subtly different from the searchByCaseIDCoverPeriodOverlap() operation insofar as it searches for records within the specified period. | SQL |
readByFinInstructIDCategoryTypeStatus | nsread | | To search for a Payment Received record on the InstructionLineItem database table, using the financialInstructionID, category code and status code to determine whether or not it can be allocated | |
searchByAdjustIndCategoryTypeDate | nsmulti | | To get a list of instructionLineItem for a particular categoryCode, TypeCode, effectiveDate, and adjustmentInd. | SQL |
searchByCategoryType | nsreadmulti | | To get all instruction Line Items of a specified category and type. | |
readSumAmtUnprocAmtByCaseIDTypeDateRange | ns | | To select the sum of the amount and unprocessed amount fields from the InstructionLineItem entity for a specified caseID, InstructionLineItemType, and effective date range. | SQL |
searchByCaseIDTypeDateRange | nsmulti | | To retrieve a subset of InstructionLineItems details for a specified CaseID Type Code & Date Range. | SQL |
searchByCaseIDTypeCode | nsreadmulti | | To search the InstructionLineItem database table by CaseID and TypeCode. | |
searchByCategoryTypeStatusCode | nsreadmulti | | Search to retrieve a list of all reconciliation records whose accounts must be balanced in order to complete the reconciliation process | |
searchByCaseIDCategoryStatusCoverPeriod | nsmulti | | Search to retrieve records based on
caseID, category, status code and cover period.
| SQL |
searchByCaseIDTypeStatusCoverPeriod | nsmulti | | Search to retrieve records based on caseID, type, status code and cover period | SQL |
searchByCategoryTypeDateRange | nsmulti | | To read records of a specific category and type within
a specific date range from the InstructionLineItem table.
| SQL |
searchByPayslipInstructionID | nsmulti | | Operation used to retrieve data using the PayslipInstructionID from the Instruction Line item. | SQL |
searchByCaseIDCategoryStatus | nsmulti | | To retrieve records from the InstructionLineItem, CaseNominee database tables using CaseID, Category and Status Codes. | SQL |
searchByCategoryTypeStatusCreditDebitType | nsreadmulti | | To retrieve records from the InstructionLineItem entity using categoryCode, typeCode, statusCode and creditDebitType. | |
searchByCaseIDStatusDateRange | nsmulti | | To retrieve a subset of InstructionLineItems details for a specified CaseID, Status & Date Range | SQL |
readLatestEffDateByCaseID | ns | | To retrieve the max. effective date from the instruction line item table. | SQL |
searchByConcernRoleIDCategoryStatus | nsmulti | | Method to return Instruction Line Item records with caseNominee details based on concernRoleID, instructLineItemCategory and statusCode | SQL |
readSumAmtByCaseIDFinInstIDCatStatus | ns | | To read the sum of the amount field based on CaseID, FinInstructID, Category and Status. | SQL |
searchForCaseIDByFinInstructID | nsmulti | | To retrieve all caseIDs from the InstructionLineItem entity based on the FinancialInstructionID. | SQL |
modifyStatusDelMethodFinInstIDUnprocAmt | nsmodify | OPTIMISTIC_LOCKING: yes
| To update the Status, DeliveryMethod, FinInstructionID and Unprocessed amount of an instruction line item record. | |
readLastPaymentDate | ns | | Reads the maximum effective date for a specified case id and concern role id, which has specified status code . | SQL |
searchByCategoryStatus | nsreadmulti | ORDER_BY: concernRoleID, currencyTypeCode, deliveryMethodType, caseID
| To retrieve instruction line item records based on the category code and a status of unprocessed. | |
searchByIntegCaseIDAndFinInstID | nsmulti | | To retrieve a subset of InstructionLineItems details for a specified integrated CaseID and FinInstructionID. | SQL |
searchByIntegCaseIDStatusDateRange | nsmulti | | To retrieve a subset of InstructionLineItems details for a specified Integrated CaseID, Status & Date Range | SQL |
readCoverPeriodFromByCaseIDFinInstID | ns | | To retrieve the earliest CoverPeriodFrom date for a canceled payment being reassessed using the CaseID & FinInstructionID | SQL |
readCoverPeriodToByCaseIDFinInstID | ns | | To retrieve the latest CoverPeriodTo date for a canceled payment being reassessed using the CaseID & FinInstructionID | SQL |
searchILIByFinInstructID | nsmulti | | To get a list of Instruction Line Items and case reference that were combined into one Financial Instruction. The caseReference returned will be null in situations where the ILI does not relate to a case, using an outer join to allow ILIs with a null caseID to be retrieved. | SQL |
readLatestCoverPeriodToForCaseAndObjective | ns | PRE_DATA_ACCESS: yes
| Retrieves the latest cover period to date for a specified case and rules objective, based on ILI records with a status of 'Processed', 'Unprocessed', 'Cancelled', 'Expired' and Transferred. | SQL |
searchByCategoriesAndStatus | nsmulti | | Search to retrieve a list of instruction line items by categories and status. | SQL |
searchDetailsForGenerateInstruments | nsmulti | PRE_DATA_ACCESS: yes
READMULTI_LIM: 0
| | SQL |
searchDeductionILIsByNominee | nsmulti | PRE_DATA_ACCESS: yes
| This method returns all the unprocessed deductions against ILIs for the specified nominee | SQL |
searchTaxILIsByNominee | nsmulti | PRE_DATA_ACCESS: yes
| This method returns all the unprocessed tax against ILIs for the specified nominee | SQL |
readCaseNomineeIDByFinInstructionID | ns | | returns the case nominee id based on the financial instruction id | SQL |
searchByFinInstructionID | nsreadmulti | ORDER_BY: financialCompID, coverPeriodTo
| | |
searchRelCaseIDByFinInstructID | nsmulti | | To get a list of CaseIDs for a specified financial instruction ID. | SQL |
readLatestProcessedCoverPeriodTo | ns | | Reads the latest cover period to date on a case for where the status is 'Processed' and the type is not 'Reversed'. | SQL |
seachDeductionILIsByNominee | | | @superseded - replaced by searchDeductionILIsByNominee | |
getDetailsForGenerateInstruments | | | @superseded - replaced by searchDetailsForGenerateInstruments | |
readEarliestCoverPeriod | ns | | Reads the earliest cover period from date based on a case identifier and a ILI status code. | SQL |
readSumAmtByCaseIDCatStatus | ns | | To read the sum of the amount field based on CaseID, Category and Status. | SQL |
readFinInstructionID | nsread | | Reads the instruction id for a specified ILI. | |
readFinComponentID | nsread | | Reads the financial component id for an instruction line item. | |
searchThirdPartyDeductionILIs | nsmulti | | Search to retrieve a list of instruction line items by categories and status, which have a blank case ID. This will find third party or un-applied deduction instruction line items. | SQL |
searchDistinctFinInstructIDByCaseStatusAndPeriod | nsmulti | | | SQL |
readCoverPeriodForFinInstructionID | ns | | | SQL |
searchTaxILIsByParticipantRoleID | nsmulti | PRE_DATA_ACCESS: yes
| This method returns all the unprocessed tax against ILIs for the specified participant | SQL |
searchDeductionILIsByParticipantRoleID | nsmulti | PRE_DATA_ACCESS: yes
| This method returns all the unprocessed deductions against ILIs for the specified nominee | SQL |
searchByCategoryStatusParticipantLink | nsmulti | | @deprecated since v 6.0.3.1, replaced by {@link #searchByCategoryStatusParticipantLink1(CategoryStatusParticipantKey)}.
This method was deprecated as additional processing needed to be added to the method SQL statement.
Used to get a list of instructionLineItem for a particular categoryCode and statusCode. | SQL |
searchByAdjustIndCategoryTypeDateForParticipant | nsmulti | | To get a list of instructionLineItem for a particular categoryCode, TypeCode, effectiveDate, and adjustmentInd. | SQL |
searchByAdjustIndCategoryDateStatusForParticipant | nsmulti | | To get a list of instructionLineItem for a particular categoryCode, effectiveDate, statusCode and adjustmentInd. | SQL |
readSumAmtByCaseIDFinInstIDCatStatusCdtDbtType | ns | | To read the sum of the amount field based on CaseID, FinInstructID, Category, Status and CdtDbtType. | SQL |
searchDetailsForTransferILIs | nsmulti | PRE_DATA_ACCESS: yes
| Search for ILIs to be transferred in transfer batch process. | SQL |
searchByStatusCode | nsreadmulti | | | |
searchTaxILIsByCatAndStatus | nsmulti | | Search to retrieve a list of instruction line items by categories and status, which have a blank case ID. This will find Tax instruction line items. | SQL |
modifyCurExchgIDEffectiveDatebyKey | nsmodify | | | |
searchCaseIDByFinInstructID | nsmulti | | To retrieve all caseIDs from the InstructionLineItem entity based on the FinancialInstructionID. | SQL |
searchByCaseIDCoverPeriodOverlap | nsmulti | | To return a list of instruction line items based on a specified case and cover period. This is subtly different from the searchByCaseIDCoverPeriod() operation insofar as it searches for line items that overlap with the search criteria. | SQL |
searchUnprocessedByCaseIDStatus | nsreadmulti | READMULTI_LIM: 300
| Reads for the list of unprocessed ILIs for a specific case. | |
countUnprocessedByCaseID | ns | | | SQL |
searchByCaseID | nsreadmulti | | | |
readRelatedDedByCaseIDReasonCodeType | ns | | Searchs for the deductions (ILI type) that relate to an underpayment through a related overpayment case (using
the case relationship reason code). The sum of the deductions found is returned. | SQL |
readLastPaymentAmountEffectiveDate | ns | | Reads the amount and the date (effective date) of the last payment made on the case the given ID refers to. Where more than one payment was issued on this date, the total amount of these payments is returned. | SQL |
modify | modify | OPTIMISTIC_LOCKING: yes
| Standard Operation | |
searchByCaseIDOpenEndedCoverPeriodOverlap | nsmulti | | To return a list of instruction line items based on a specified case and cover period. This is subtly different from the searchByCaseIDCoverPeriod() operation insofar as it searches for line items that overlap with the search criteria. This version can also cope with cover period to dates which are null which can occur on cases which are open ended. | SQL |
readLastPaymentAndEffectiveDate | ns | | Reads the amount and the date (effective date) of the last payment made and processed on the case the given ID refers to. Where more than one payment was issued on this date, the total amount of the payments (excluding cancelled payment) is returned. | SQL |
searchManualPmtsReceived | nsmulti | | This method returns all manual payments received in relation to a liability. | SQL |
searchByCaseIDAndCategory | nsreadmulti | | Method to retrieve all Instruction Line Items for a particular case and category. | |
searchByCaseIDFinInstructionID | nsreadmulti | | Returns Instruction Line Item records for a given Case ID and Financial Instruction ID. | |
readLatestCoverPeriodToForCaseAndListObjective | ns | PRE_DATA_ACCESS: yes
| Retrieves the latest cover period to date for a specified case and list objective (list objectives are distinguished using the related reference), based on ILI records with a status of 'Processed', 'Unprocessed', 'Cancelled', 'Expired' and Transferred. | SQL |
readLatestCoverPeriodToForCaseNomineeAndObjective | ns | PRE_DATA_ACCESS: yes
| Retrieves the latest cover period to date for a specified case nominee and rules objective, based on ILI records with a status of 'Processed', 'Unprocessed', 'Cancelled', 'Expired' and Transferred. | SQL |
readLatestCoverPeriodToForCaseNomineeAndListObjective | ns | PRE_DATA_ACCESS: yes
| Retrieves the latest cover period to date for a specified case nominee and list objective (list objectives are distinguished using the related reference), based on ILI records with a status of 'Processed', 'Unprocessed', 'Cancelled', 'Expired' and Transferred. | SQL |
searchDebitAllocationsAndRelatedCase | nsmulti | | To get information on the (credit) instruction line items to which the specified debit instruction line item is allocated, including the case identifier of the related credit instruction line item. | SQL |
searchByCategoryStatusParticipantLink1 | nsmulti | | Gets a list of instructionLineItem for a particular categoryCode and statusCode. | SQL |
searchByFinInstructIDCategoryTypeStatus | nsreadmulti | | Method to retrieve all Instruction Line Items for a the specified financial instruction, category and status. | |
readCaseIDAndReferenceByFinComponentID | ns | | Returns the case id and case reference based on the financial component id.
| SQL |
countByFinancialCompID | ns | | Retrieves a count of instruction line items associated with the specified financial component. | SQL |
readEarliestCoverPeriodForCase | ns | | Reads the earliest cover period from date based on a case identifier - regardless of status. | SQL |