org.apache.isis.core.metamodel.interactions

Interface ValidatingInteractionAdvisor

All Superinterfaces:

Facet, FacetAbstract.Validating, InteractionAdvisor, InteractionAdvisorFacet

All Known Subinterfaces:

ActionValidationFacet, CollectionValidateAddToFacet, CollectionValidateRemoveFromFacet, MandatoryFacet, MaskFacet, MaxLengthFacet, ObjectValidPropertiesFacet, PropertyValidateFacet, RegExFacet, ValidateObjectFacet

All Known Implementing Classes:

ActionValidationFacetAbstract, ActionValidationFacetViaMethod, ChoicesFacetFromBoundedAbstract, ChoicesFacetFromBoundedAnnotation, ChoicesFacetFromBoundedFacetMarkerInterface, CollectionValidateAddToFacetAbstract, CollectionValidateAddToFacetViaMethod, CollectionValidateRemoveFromFacetAbstract, CollectionValidateRemoveFromFacetViaMethod, MandatoryFacetAbstract, MandatoryFacetDefault, MandatoryFacetExplicitForProperty, MandatoryFacetInvertedByOptionalForParameter, MandatoryFacetInvertedByOptionalForProperty, MandatoryFacetOptionalViaMethodForParameter, MandatoryFacetOptionalViaMethodForProperty, MaskFacetAbstract, MaskFacetAnnotationForParameter, MaskFacetAnnotationForProperty, MaskFacetAnnotationForType, MaxLengthFacetAbstract, MaxLengthFacetAnnotationForParameter, MaxLengthFacetAnnotationForProperty, MaxLengthFacetAnnotationForType, MaxLengthFacetUnlimited, MustSatisfySpecificationOnParameterFacet, MustSatisfySpecificationOnPropertyFacet, MustSatisfySpecificationOnTypeFacet, ObjectValidPropertiesFacetAbstract, ObjectValidPropertiesFacetImpl, PropertyValidateFacetAbstract, PropertyValidateFacetDefault, PropertyValidateFacetNone, PropertyValidateFacetViaMethod, RegExFacetAbstract, RegExFacetAnnotationForParameter, RegExFacetAnnotationForProperty, RegExFacetAnnotationForType, ValidateObjectFacetAbstract, ValidateObjectFacetViaValidateMethod

public interface ValidatingInteractionAdvisor
extends InteractionAdvisorFacet, FacetAbstract.Validating

Mix-in interface for Facets that can advise as to whether a proposed value is valid.

For example, MaxLengthFacet does constrain the length of candidate values, whereas DebugFacet or MemberOrderFacet do not - they are basically just UI hints.

See Also:

DisablingInteractionAdvisor, HidingInteractionAdvisor

Field Summary

Fields inherited from interface org.apache.isis.core.metamodel.interactions.InteractionAdvisorFacet

NOOP

Method Summary

Methods

Modifier and Type	Method and Description
String	invalidates(ValidityContext<? extends org.apache.isis.applib.events.ValidityEvent> ic) Whether the validation represented by this facet passes or fails.

Methods inherited from interface org.apache.isis.core.metamodel.facetapi.Facet

alwaysReplace, facetType, getFacetHolder, getUnderlyingFacet, isDerived, isNoop, setFacetHolder, setUnderlyingFacet

Method Detail

invalidates

String invalidates(ValidityContext<? extends org.apache.isis.applib.events.ValidityEvent> ic)

Whether the validation represented by this facet passes or fails.

Implementations should use the provided ValidityContext to determine whether they declare the interaction invalid. They must however guard against a null target and session - neither are guaranteed to be populated.