Package com.ptc.core.meta.container.common

Interface ActionValidator

All Known Implementing Classes:

com.ptc.core.meta.container.common.AbstractValidator, AttributeContainerSetValidator, ConstraintsValidator, IsCheckedInValidator, IsCheckedOutPrincipalValidator, IsCheckedOutProjectValidator, IsCheckedOutValidator, IsInPersonalCabinetValidator, IsLatestIterationValidator, IsLockedByValidator, IsLockedValidator, IsOneOffVersionValidator, IsOwnedByValidator, IsOwnedValidator, IsReviseAllowedValidator, IsShortcutValidator, IsWorkingCopyPrincipalValidator, IsWorkingCopyValidator, MultiSelectValidator, SingleSelectValidator

public interface ActionValidator

Interface for the common methods of Validators.

Supported API: true

Extendable: true

Method Summary

Modifier and Type	Method	Description
AttributeContainerSpec	getFilter(AttributeContainerSpec the_filter, TypeIdentifier type_identifier)	Will add the filter this validator needs to the supplied parameter and return that parameter.
AttributeContainerSpec	getFilter(AttributeContainerSpec the_filter, String logical_id, TypeIdentifier type_identifier)	Will add the filter this validator needs to the supplied parameter and return that parameter.
boolean	isValid(AttributeContainer attribute_container)	Returns false only if the validator check specifically fails.

Method Details

isValid

boolean isValid(AttributeContainer attribute_container)
         throws InvalidFunctionArgumentException

Returns false only if the validator check specifically fails. Even if there is an error message caused by some exception, it will return true. Calls calculate which is implemented by concrete validators.

Supported API: true

Parameters:

attribute_container -

Returns:

boolean

Throws:

InvalidFunctionArgumentException

getFilter

AttributeContainerSpec getFilter(AttributeContainerSpec the_filter,
 TypeIdentifier type_identifier)

Will add the filter this validator needs to the supplied parameter and return that parameter. This API is implemented by the concrete validators.

Supported API: true

Parameters:

the_filter -

type_identifier - Used to get the DefinitionIdentifier for constructing the AttributeTypeIdentifier

Returns:

AttributeContainerSpec

getFilter

AttributeContainerSpec getFilter(AttributeContainerSpec the_filter,
 String logical_id,
 TypeIdentifier type_identifier)

Will add the filter this validator needs to the supplied parameter and return that parameter. This API is used by the AbstractValidator

Supported API: true

Parameters:

the_filter -

logical_id -

type_identifier - Used to get the DefinitionIdentifier for constructing the AttributeTypeIdentifier

Returns:

AttributeContainerSpec