org.kuali.kra.proposaldevelopment.rules

Class CreditSplitValidator

java.lang.Object

org.kuali.kra.proposaldevelopment.rules.CreditSplitValidator

All Implemented Interfaces:

Traceable<CreditSplitValidator>

public class CreditSplitValidator
extends Object
implements Traceable<CreditSplitValidator>

Validates Credit Splits on a ProposalPerson and/or ProposalPersonUnit by traversing the tree of ProposalPerson ProposalPersonUnit instances.

Version:

$Revision: 1.11 $

Author:

$Author: gmcgrego $

Constructor Summary

Constructors

Constructor and Description
CreditSplitValidator()

Method Summary

Methods

Modifier and Type	Method and Description
static CreditSplitValidator	getInstance()
CreditSplitValidator	getProxy(CreditSplitValidator archetype) Rely on the class to know how to build its own proxy for trace logging
protected boolean	isCreditSplitValid(org.kuali.rice.core.api.util.type.KualiDecimal value) Determine if the value of the credit split is valid.
boolean	validate(Collection<ProposalPerson> investigators, InvestigatorCreditType creditType) Validates credit splits of all investigators in a ProposalDevelopmentDocument.
boolean	validate(ProposalDevelopmentDocument document) Validates the credit splits of an entire document by traversing it.
boolean	validateCreditSplit(Iterator<? extends CreditSplit> creditSplit_it, InvestigatorCreditType creditType, org.kuali.kra.proposaldevelopment.rules.CreditSplitValidator.DecimalHolder lesserCummulative) Validates a collection of anything splits.
boolean	validateCreditSplitable(Iterator<? extends CreditSplitable> splitable_it, InvestigatorCreditType creditType, org.kuali.kra.proposaldevelopment.rules.CreditSplitValidator.DecimalHolder greaterCummulative) Validates a collection of anything splitable.

Methods inherited from class java.lang.Object

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

Constructor Detail

CreditSplitValidator

public CreditSplitValidator()

Method Detail

validate

public boolean validate(ProposalDevelopmentDocument document)

Validates the credit splits of an entire document by traversing it. If the Investigator is instead a Principal Investigator, the units should all add up to 100.0.

Parameters:

document - The document to validate the credit splits of

Returns:

boolean

validate

public boolean validate(Collection<ProposalPerson> investigators,
               InvestigatorCreditType creditType)

Validates credit splits of all investigators in a ProposalDevelopmentDocument. Takes a Collection of investigators for a given credit type, and validates credit splits for each investigator as well as iterating and validating credit splits for each unit belonging to an investigator.

Parameters:

investigators -

creditTypeCode -

Returns:

true if the investigator collection is valid for the credit type, and false if it's invalid

validateCreditSplitable

public boolean validateCreditSplitable(Iterator<? extends CreditSplitable> splitable_it,
                              InvestigatorCreditType creditType,
                              org.kuali.kra.proposaldevelopment.rules.CreditSplitValidator.DecimalHolder greaterCummulative)

Validates a collection of anything splitable. This implies that it contains CreditSplit instances.

Parameters:

splitable_it -

creditType -

greaterCummulative -

Returns:

boolean is valid?

validateCreditSplit

public boolean validateCreditSplit(Iterator<? extends CreditSplit> creditSplit_it,
                          InvestigatorCreditType creditType,
                          org.kuali.kra.proposaldevelopment.rules.CreditSplitValidator.DecimalHolder lesserCummulative)

Validates a collection of anything splits. Negative values and values exceeding 100.00 are not permissible.

Parameters:

creditSplit_it -

creditType -

lesserCummulative -

Returns:

boolean true if it is a valid percentage (falls between 0.00 and 100.00)

isCreditSplitValid

protected boolean isCreditSplitValid(org.kuali.rice.core.api.util.type.KualiDecimal value)

Determine if the value of the credit split is valid. Values not between 0.00 and 100.00 percent are considered invalid.

Parameters:

value - of the credit split to validate

Returns:

false if negative or greater than 100.00

getInstance

public static CreditSplitValidator getInstance()

getProxy

public CreditSplitValidator getProxy(CreditSplitValidator archetype)

Description copied from interface: Traceable

Rely on the class to know how to build its own proxy for trace logging

Specified by:

getProxy in interface Traceable<CreditSplitValidator>

Parameters:

archetype - instance applied to the proxy.

Returns:

a proxy for T with archetype set

See Also:

Traceable.getProxy(java.lang.Object)