org.kuali.ole.sys.service

Interface BankService

All Known Implementing Classes:

BankServiceImpl

public interface BankService

This service interface defines methods that a BankService implementation must provide.

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	PERMANENT_BANK_SPECIFICATION_ENABLED_DOCUMENT_TYPES

Method Summary

Methods

Modifier and Type	Method and Description
Bank	getByPrimaryId(String bankCode) Retrieves a bank object who's primary id matches the values provided.
Bank	getDefaultBankByDocType(Class<?> documentClass) Retrieves the default bank code for the given document type from system parameter.
Bank	getDefaultBankByDocType(String documentTypeCode) Retrieves the default bank code for the given document type from system parameter.
boolean	isBankSpecificationEnabled() Determines if the bank specification is enabled in the system by system parameter.
boolean	isBankSpecificationEnabledForDocument(Class<?> documentClass) Determines if the bank specification is enabled for the given document by a) the document being one of the permanent bank code documents (AD's, CMD's, and ND's) or by the document being listed in the KFS-SYS / Bank / BANK_CODE_DOCUMENT_TYPES parameter

Field Detail

PERMANENT_BANK_SPECIFICATION_ENABLED_DOCUMENT_TYPES

static final String[] PERMANENT_BANK_SPECIFICATION_ENABLED_DOCUMENT_TYPES

Method Detail

getByPrimaryId

Bank getByPrimaryId(String bankCode)

Retrieves a bank object who's primary id matches the values provided.

Parameters:

bankCode - The bank code to be looked up by.

Returns:

A Bank object with a matching primary id.

getDefaultBankByDocType

Bank getDefaultBankByDocType(Class<?> documentClass)

Retrieves the default bank code for the given document type from system parameter. .

Parameters:

documentClass - Class for the document type

Returns:

Bank object retrieved by default bank code

getDefaultBankByDocType

Bank getDefaultBankByDocType(String documentTypeCode)

Retrieves the default bank code for the given document type from system parameter. .

Parameters:

documentTypeCode - the document type code

Returns:

Bank object retrieved by default bank code

isBankSpecificationEnabled

boolean isBankSpecificationEnabled()

Determines if the bank specification is enabled in the system by system parameter.

Returns:

true if specification is enabled

isBankSpecificationEnabledForDocument

boolean isBankSpecificationEnabledForDocument(Class<?> documentClass)

Determines if the bank specification is enabled for the given document by a) the document being one of the permanent bank code documents (AD's, CMD's, and ND's) or by the document being listed in the KFS-SYS / Bank / BANK_CODE_DOCUMENT_TYPES parameter

Parameters:

documentClass - the class of the document to determine if it has bank specifications enabled

Returns:

true if specification is enabled, false if specification is disabled