org.kuali.kfs.integration.cab

Interface CapitalAssetBuilderModuleService

All Known Implementing Classes:

CapitalAssetBuilderModuleServiceImpl, CapitalAssetBuilderModuleServiceNoOp

public interface CapitalAssetBuilderModuleService

Method Summary

Methods

Modifier and Type	Method and Description
boolean	doesAccountingLineFailAutomaticPurchaseOrderRules(AccountingLine accountingLine)
boolean	doesDocumentFailAutomaticPurchaseOrderRules(AccountingDocument accountingDocument)
boolean	doesItemNeedCapitalAsset(String itemTypeCode, List accountingLines)
void	filterNonCapitalAssets(List<CapitalAssetInformation> infos) This function removes CapitalAssetInformations that don't have at least one capital asset object code in their group details.
List<CapitalAssetBuilderAssetTransactionType>	getAllAssetTransactionTypes()
List<String>	getBatchExcludedChartCodes() Get CAB Batch parameter value of disallowed chart codes
List<String>	getBatchExcludedSubFundCodes() Get CAB Batch parameter value of disallowed sub fund codes
List<String>	getBatchIncludedObjectSubTypes() Get CAB Batch parameter value of allowed financial object sub types
String	getCurrentPurchaseOrderDocumentNumber(String camsDocumentNumber) Get current Purchase Order Document number for given CAMS Document Number
boolean	hasCAMSCapitalAssetObjectSubType(AccountingLine line)
boolean	hasCapitalAssetObjectSubType(AccountingDocument accountingDocument) determine whether there is any object code of the given source accounting lines with a capital asset object sub type
boolean	hasCapitalAssetObjectSubType(AccountingLine accountingLine)
boolean	isAssetLineEligibleForCABBatch(CapitalAssetInformation assetInfoLine, Integer postingYear, List<String> includedObjectSubTypeCodes, List<String> excludedChartCodes, List<String> excludedSubFundCodes) Check FP document individual Capital Asset line eligibility for CAB Extract Batch
boolean	isAssetTypeExisting(String assetTypeCode) Check the existence of asset type code
boolean	isDocumentEligibleForCABBatch(String documentType) Check FP document eligibility by document type for CAB Extract batch.
boolean	markProcessedGLEntryLine(String documentNumber) mark the gl entry line if all the capital asset lines have been processed
void	notifyRouteStatusChange(org.kuali.rice.krad.bo.DocumentHeader documentHeader) External modules can notify CAB if a document changed its route status.
void	reactivatePretagDetails(String campusTagNumber) Sets the PretagDetails to active that are associated with the campusTagNumber passed in as a parameter.
boolean	validateAccountsPayableData(AccountingDocument accountingDocument)
boolean	validateAddItemCapitalAssetBusinessRules(ItemCapitalAsset asset)
boolean	validateAllCapitalAccountingLinesProcessed(AccountingDocument accountingDocumentForValidation) validates all capital accounting lines that have been processed.
boolean	validateAllFieldRequirementsByChart(AccountingDocument accountingDocument)
boolean	validateAssetTags(AccountingDocument accountingDocument)
boolean	validateCapitalAccountingLines(AccountingDocument accountingDocumentForValidation) validates whether capital assets exist for any given capital accounting line.
boolean	validateCapitlAssetsAmountToAccountingLineAmount(AccountingDocument accountingDocument) determine whether the any capital accounting line's amount matches with all the capital assets for that capital accounting line.
boolean	validateFinancialProcessingData(AccountingDocument accountingDocument, CapitalAssetInformation capitalAssetInformation, int index) validate the capitalAssetManagementAsset data associated with the given accounting document
boolean	validateItemCapitalAssetWithErrors(String recurringPaymentTypeCode, ExternalPurApItem item, boolean apoCheck)
boolean	validatePurchasingData(AccountingDocument accountingDocument)
boolean	validatePurchasingObjectSubType(AccountingDocument accountingDocument)
boolean	validateTotalAmountMatch(AccountingDocument accountingDocumentForValidation) determine whether the given document's all capital accounting lines totals match to that of capital assets.
boolean	validateUpdateCAMSView(AccountingDocument accountingDocumen)
boolean	warningObjectLevelCapital(AccountingDocument accountingDocument)

Method Detail

isAssetTypeExisting

boolean isAssetTypeExisting(String assetTypeCode)

Check the existence of asset type code

Parameters:

assetTypeCode -

Returns:

getCurrentPurchaseOrderDocumentNumber

String getCurrentPurchaseOrderDocumentNumber(String camsDocumentNumber)

Get current Purchase Order Document number for given CAMS Document Number

Parameters:

camsDocumentNumber -

Returns:

validateFinancialProcessingData

boolean validateFinancialProcessingData(AccountingDocument accountingDocument,
                                      CapitalAssetInformation capitalAssetInformation,
                                      int index)

validate the capitalAssetManagementAsset data associated with the given accounting document

Parameters:

accountingDocument - the given accounting document

capitalAssetManagementAsset - data to be validated

Returns:

validation succeeded or errors present

validatePurchasingData

boolean validatePurchasingData(AccountingDocument accountingDocument)

validateAccountsPayableData

boolean validateAccountsPayableData(AccountingDocument accountingDocument)

doesAccountingLineFailAutomaticPurchaseOrderRules

boolean doesAccountingLineFailAutomaticPurchaseOrderRules(AccountingLine accountingLine)

doesDocumentFailAutomaticPurchaseOrderRules

boolean doesDocumentFailAutomaticPurchaseOrderRules(AccountingDocument accountingDocument)

doesItemNeedCapitalAsset

boolean doesItemNeedCapitalAsset(String itemTypeCode,
                               List accountingLines)

validateUpdateCAMSView

boolean validateUpdateCAMSView(AccountingDocument accountingDocumen)

validateAddItemCapitalAssetBusinessRules

boolean validateAddItemCapitalAssetBusinessRules(ItemCapitalAsset asset)

warningObjectLevelCapital

boolean warningObjectLevelCapital(AccountingDocument accountingDocument)

validateItemCapitalAssetWithErrors

boolean validateItemCapitalAssetWithErrors(String recurringPaymentTypeCode,
                                         ExternalPurApItem item,
                                         boolean apoCheck)

getAllAssetTransactionTypes

List<CapitalAssetBuilderAssetTransactionType> getAllAssetTransactionTypes()

notifyRouteStatusChange

void notifyRouteStatusChange(org.kuali.rice.krad.bo.DocumentHeader documentHeader)

External modules can notify CAB if a document changed its route status. CAB Uses this notification to release records or to update other modules about the changes

Parameters:

documentHeader - DocumentHeader

hasCapitalAssetObjectSubType

boolean hasCapitalAssetObjectSubType(AccountingDocument accountingDocument)

determine whether there is any object code of the given source accounting lines with a capital asset object sub type

Parameters:

accountingLines - the given source accounting lines

Returns:

true if there is at least one object code of the given source accounting lines with a capital asset object sub type; otherwise, false

validateAllFieldRequirementsByChart

boolean validateAllFieldRequirementsByChart(AccountingDocument accountingDocument)

validatePurchasingObjectSubType

boolean validatePurchasingObjectSubType(AccountingDocument accountingDocument)

hasCapitalAssetObjectSubType

boolean hasCapitalAssetObjectSubType(AccountingLine accountingLine)

validateAssetTags

boolean validateAssetTags(AccountingDocument accountingDocument)

validateAllCapitalAccountingLinesProcessed

boolean validateAllCapitalAccountingLinesProcessed(AccountingDocument accountingDocumentForValidation)

validates all capital accounting lines that have been processed.

Parameters:

accountingDocumentForValidation -

Returns:

true if all lines have been processes else return false

validateTotalAmountMatch

boolean validateTotalAmountMatch(AccountingDocument accountingDocumentForValidation)

determine whether the given document's all capital accounting lines totals match to that of capital assets.

Parameters:

accountingDocumentForValidation -

Returns:

true if totals match else return false

validateCapitlAssetsAmountToAccountingLineAmount

boolean validateCapitlAssetsAmountToAccountingLineAmount(AccountingDocument accountingDocument)

determine whether the any capital accounting line's amount matches with all the capital assets for that capital accounting line.

Parameters:

accountingDocument -

Returns:

true if totals match else return false

validateCapitalAccountingLines

boolean validateCapitalAccountingLines(AccountingDocument accountingDocumentForValidation)

validates whether capital assets exist for any given capital accounting line.

Parameters:

accountingDocumentForValidation -

Returns:

true if capital assets exist for capital accounting line else return false.

markProcessedGLEntryLine

boolean markProcessedGLEntryLine(String documentNumber)

mark the gl entry line if all the capital asset lines have been processed

Parameters:

documentNumber -

Returns:

true if gl entry line marked as processed else return false.

reactivatePretagDetails

void reactivatePretagDetails(String campusTagNumber)

Sets the PretagDetails to active that are associated with the campusTagNumber passed in as a parameter. This needs to be done when the AssetGlobalDocument is cancelled.

Parameters:

campusTagNumber - String key used to find pretagDetails to reactivate

hasCAMSCapitalAssetObjectSubType

boolean hasCAMSCapitalAssetObjectSubType(AccountingLine line)

isDocumentEligibleForCABBatch

boolean isDocumentEligibleForCABBatch(String documentType)

Check FP document eligibility by document type for CAB Extract batch.

Parameters:

documentType -

Returns:

isAssetLineEligibleForCABBatch

boolean isAssetLineEligibleForCABBatch(CapitalAssetInformation assetInfoLine,
                                     Integer postingYear,
                                     List<String> includedObjectSubTypeCodes,
                                     List<String> excludedChartCodes,
                                     List<String> excludedSubFundCodes)

Check FP document individual Capital Asset line eligibility for CAB Extract Batch

Parameters:

assetInfoLine -

postingYear -

Returns:

getBatchIncludedObjectSubTypes

List<String> getBatchIncludedObjectSubTypes()

Get CAB Batch parameter value of allowed financial object sub types

Returns:

getBatchExcludedChartCodes

List<String> getBatchExcludedChartCodes()

Get CAB Batch parameter value of disallowed chart codes

Returns:

getBatchExcludedSubFundCodes

List<String> getBatchExcludedSubFundCodes()

Get CAB Batch parameter value of disallowed sub fund codes

Returns:

filterNonCapitalAssets

void filterNonCapitalAssets(List<CapitalAssetInformation> infos)

This function removes CapitalAssetInformations that don't have at least one capital asset object code in their group details.

Parameters:

infos -