Package com.ptc.core.businessRules.validation

Class CheckoutRuleValidator

java.lang.Object

com.ptc.core.businessRules.validation.CheckoutRuleValidator

All Implemented Interfaces:

RuleValidation

public class CheckoutRuleValidator
extends Object
implements RuleValidation

This class is a validator configured to execute with the BusinessRules engine. As such, it extends RuleValidation.

This class validates whether or not a set of workable objects has checkouts. This validator will return RuleValidationStatus.SUCCESS if no objects are checked out. It will return RuleValidationStatus.FAILURE if there is at least one object checked out. This can be invoked by calling the business rules engine:

BusinessRulesHelper.engine.execute("CHANGEABLE_PRE_RELEASE", criteria);



Supported API: true

Extendable: true

Method Summary

Modifier and Type	Method	Description
static WTKeyedHashMap	getCheckedoutObjects(WTCollection targets)	Returns a set of objects that are checked out.
Class<?>[]	getSupportedClasses(RuleValidationKey validationKey)	Returns {Workable.class} Supported API: true
boolean	isConfigurationValid(RuleValidationKey validationKey)	Returns true.
RuleValidationResult	performValidation(RuleValidationKey validationKey, RuleValidationObject validationObject, RuleValidationCriteria criteria)	Examines the invalidObjects collection of this class and determines if there are any invalid objects or not.
void	prepareForValidation(RuleValidationKey validationKey, RuleValidationCriteria criteria)	Perform the validation against the criteria to determine if there are any checked out objects.

Methods inherited from class java.lang.Object

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

Method Details

getSupportedClasses

public Class<?>[] getSupportedClasses(RuleValidationKey validationKey)

Returns {Workable.class} Supported API: true

Specified by:

getSupportedClasses in interface RuleValidation

Returns:

the array of classes

isConfigurationValid

public boolean isConfigurationValid(RuleValidationKey validationKey)
                             throws WTException

Returns true. Supported API: true

Specified by:

isConfigurationValid in interface RuleValidation

Returns:

true when the configuration is valid

Throws:

WTException

performValidation

public RuleValidationResult performValidation(RuleValidationKey validationKey,
 RuleValidationObject validationObject,
 RuleValidationCriteria criteria)
                                       throws WTException

Examines the invalidObjects collection of this class and determines if there are any invalid objects or not. If there are, it checks to see if the current targetObject exists within the invalidObjects set. If it exists in the set, RuleValidationStatus.FAILURE will be returned in the RuleValidationResult. Otherwise, the RuleValidationResult will have a RuleValidationStatus.SUCCESS. Supported API: true

Specified by:

performValidation in interface RuleValidation

Returns:

validation result

Throws:

WTException

getCheckedoutObjects

public static WTKeyedHashMap getCheckedoutObjects(WTCollection targets)
                                           throws WTException

Returns a set of objects that are checked out. This will check objects that are work in progress checked out, or sandbox checked out. Supported API: true

Throws:

WTException

prepareForValidation

public void prepareForValidation(RuleValidationKey validationKey,
 RuleValidationCriteria criteria)
                          throws WTException

Perform the validation against the criteria to determine if there are any checked out objects. Supported API: true

Specified by:

prepareForValidation in interface RuleValidation

Throws:

WTException