org.kuali.ole.module.purap.document.validation.impl

Class InvoiceProcessItemValidation

java.lang.Object

org.kuali.ole.sys.document.validation.ParameterizedValidation

org.kuali.ole.sys.document.validation.GenericValidation

org.kuali.ole.module.purap.document.validation.impl.InvoiceProcessItemValidation

All Implemented Interfaces:

Validation

Direct Known Subclasses:

OleInvoiceProcessItemValidation

public class InvoiceProcessItemValidation
extends GenericValidation

Constructor Summary

Constructors

Constructor and Description
InvoiceProcessItemValidation()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addParametersToValidation(AccountingLineAmountPositiveValidation validation)
protected void	addParametersToValidation(AccountingLineDataDictionaryValidation validation)
protected void	addParametersToValidation(AccountingLineValuesAllowedValidationHutch validation)
protected void	addParametersToValidation(BusinessObjectDataDictionaryValidation validation)
boolean	canApproveAccountingLinesWithZeroAmount() checks if an accounting line with zero dollar amount can be approved.
protected void	createGauntlet(CompositeValidation validation)
protected AttributedDocumentEvent	getEvent() Gets the event attribute.
PurApItem	getItemForValidation()
protected PurApAccountingLine	getPreqAccountingLine() Gets the invoiceAccountingLine attribute.
protected InvoiceDocument	getPreqDocument() Gets the invoiceDocument attribute.
PurapService	getPurapService()
CompositeValidation	getReviewAccountingLineValidation()
protected boolean	reviewAccountingLineValidation(InvoiceDocument document, PurApAccountingLine accountingLine)
protected void	setEvent(AttributedDocumentEvent event) Sets the event attribute value.
void	setItemForValidation(PurApItem itemForValidation)
protected void	setPreqAccountingLine(PurApAccountingLine invoiceAccountingLine) Sets the invoiceAccountingLine attribute value.
protected void	setPreqDocument(InvoiceDocument invoiceDocument) Sets the invoiceDocument attribute value.
void	setPurapService(PurapService purapService)
void	setReviewAccountingLineValidation(CompositeValidation reviewAccountingLineValidation)
boolean	validate(AttributedDocumentEvent event) This method validates that certain parameters
protected boolean	validateAboveTheLineItems(InvoiceItem item, String identifierString, boolean isReceivingDocumentRequiredIndicator) Validates above the line items.
protected boolean	validateEachItem(InvoiceDocument invoiceDocument, InvoiceItem item) Calls another validate item method and passes an identifier string from the item.
boolean	validateItem(InvoiceDocument invoiceDocument, InvoiceItem item, String identifierString) Performs validation if full document entry not completed and peforms varying item validation.
boolean	validateItemAccounts(InvoiceDocument invoiceDocument, InvoiceItem item, String identifierString) Validates the totals for the item by account, that the total by each accounting line for the item, matches the extended price on the item.
boolean	validateItemWithoutAccounts(InvoiceItem item, String identifierString) Validates that the item must contain at least one account
protected boolean	validateProrationType(InvoiceDocument invoiceDocument)

Methods inherited from class org.kuali.ole.sys.document.validation.GenericValidation

setQuitOnFail, shouldQuitOnFail, stageValidation

Methods inherited from class org.kuali.ole.sys.document.validation.ParameterizedValidation

getParameterProperties, populateParameterFromEvent, populateParametersFromEvent, setParameterProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

InvoiceProcessItemValidation

public InvoiceProcessItemValidation()

Method Detail

validate

public boolean validate(AttributedDocumentEvent event)

Description copied from interface: Validation

This method validates that certain parameters

Returns:

true if validation should continue, false otherwise

validateEachItem

protected boolean validateEachItem(InvoiceDocument invoiceDocument,
                       InvoiceItem item)

Calls another validate item method and passes an identifier string from the item.

Parameters:

invoiceDocument - - payment request document.

item -

Returns:

validateItem

public boolean validateItem(InvoiceDocument invoiceDocument,
                   InvoiceItem item,
                   String identifierString)

Performs validation if full document entry not completed and peforms varying item validation. Such as, above the line, items without accounts, items with accounts.

Parameters:

invoiceDocument - - payment request document

item - - payment request item

identifierString - - identifier string used to mark in an error map

Returns:

validateProrationType

protected boolean validateProrationType(InvoiceDocument invoiceDocument)

validateAboveTheLineItems

protected boolean validateAboveTheLineItems(InvoiceItem item,
                                String identifierString,
                                boolean isReceivingDocumentRequiredIndicator)

Validates above the line items.

Parameters:

item - - payment request item

identifierString - - identifier string used to mark in an error map

Returns:

validateItemWithoutAccounts

public boolean validateItemWithoutAccounts(InvoiceItem item,
                                  String identifierString)

Validates that the item must contain at least one account

Parameters:

item - - payment request item

Returns:

validateItemAccounts

public boolean validateItemAccounts(InvoiceDocument invoiceDocument,
                           InvoiceItem item,
                           String identifierString)

Validates the totals for the item by account, that the total by each accounting line for the item, matches the extended price on the item.

Parameters:

invoiceDocument - - payment request document

item - - payment request item to validate

identifierString - - identifier string used to mark in an error map

Returns:

getReviewAccountingLineValidation

public CompositeValidation getReviewAccountingLineValidation()

setReviewAccountingLineValidation

public void setReviewAccountingLineValidation(CompositeValidation reviewAccountingLineValidation)

getPurapService

public PurapService getPurapService()

setPurapService

public void setPurapService(PurapService purapService)

getItemForValidation

public PurApItem getItemForValidation()

setItemForValidation

public void setItemForValidation(PurApItem itemForValidation)

reviewAccountingLineValidation

protected boolean reviewAccountingLineValidation(InvoiceDocument document,
                                     PurApAccountingLine accountingLine)

createGauntlet

protected void createGauntlet(CompositeValidation validation)

canApproveAccountingLinesWithZeroAmount

public boolean canApproveAccountingLinesWithZeroAmount()

checks if an accounting line with zero dollar amount can be approved. This will check the system parameter APPROVE_ACCOUNTING_LINES_WITH_ZERO_DOLLAR_AMOUNT_IND and determines if the line can be approved or not.

Returns:

true if the system parameter value is Y else returns N.

addParametersToValidation

protected void addParametersToValidation(BusinessObjectDataDictionaryValidation validation)

addParametersToValidation

protected void addParametersToValidation(AccountingLineAmountPositiveValidation validation)

addParametersToValidation

protected void addParametersToValidation(AccountingLineDataDictionaryValidation validation)

addParametersToValidation

protected void addParametersToValidation(AccountingLineValuesAllowedValidationHutch validation)

getEvent

protected AttributedDocumentEvent getEvent()

Gets the event attribute.

Returns:

Returns the event.

setEvent

protected void setEvent(AttributedDocumentEvent event)

Sets the event attribute value.

Parameters:

event - The event to set.

getPreqDocument

protected InvoiceDocument getPreqDocument()

Gets the invoiceDocument attribute.

Returns:

Returns the invoiceDocument.

setPreqDocument

protected void setPreqDocument(InvoiceDocument invoiceDocument)

Sets the invoiceDocument attribute value.

Parameters:

invoiceDocument - The invoiceDocument to set.

getPreqAccountingLine

protected PurApAccountingLine getPreqAccountingLine()

Gets the invoiceAccountingLine attribute.

Returns:

Returns the invoiceAccountingLine.

setPreqAccountingLine

protected void setPreqAccountingLine(PurApAccountingLine invoiceAccountingLine)

Sets the invoiceAccountingLine attribute value.

Parameters:

invoiceAccountingLine - The invoiceAccountingLine to set.