org.apache.isis.core.metamodel.interactions

Interface DisablingInteractionAdvisor

All Superinterfaces:

Facet, FacetAbstract.Disabling, InteractionAdvisor, InteractionAdvisorFacet

All Known Subinterfaces:

AuthorizationFacet, DisabledFacet, DisabledObjectFacet, DisableForContextFacet, DisableForSessionFacet, ImmutableFacet, NotPersistableFacet

All Known Implementing Classes:

AuthorizationFacetAbstract, AuthorizationFacetImpl, ChoicesFacetFromBoundedAbstract, ChoicesFacetFromBoundedAnnotation, ChoicesFacetFromBoundedFacetMarkerInterface, DisabledFacetAbstract, DisabledFacetAlwaysEverywhere, DisabledFacetAnnotation, DisabledFacetForCollectionDerivedFromImmutable, DisabledFacetForPropertyDerivedFromImmutable, DisabledFacetFromProperties, DisabledFacetImpl, DisabledFacetNever, DisabledObjectFacetAbstract, DisabledObjectFacetViaDisabledMethod, DisableForContextFacetAbstract, DisableForContextFacetNone, DisableForContextFacetViaMethod, DisableForSessionFacetAbstract, DisableForSessionFacetNone, DisableForSessionFacetViaMethod, ImmutableFacetAbstract, ImmutableFacetAnnotation, ImmutableFacetMarkerInterface, ImmutableFacetViaValueSemantics, NotPersistableFacetAbstract, NotPersistableFacetAnnotation, NotPersistableFacetImpl, NotPersistableFacetMarkerInterface, NotPersistableFacetNull

public interface DisablingInteractionAdvisor
extends InteractionAdvisorFacet, FacetAbstract.Disabling

Mix-in interface for facets that can advise as to whether a member should be disabled.

See Also:

ValidatingInteractionAdvisor, 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	disables(UsabilityContext<? extends org.apache.isis.applib.events.UsabilityEvent> ic) Whether the rule represented by this facet disables the member to which it applies.

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

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

Method Detail

disables

String disables(UsabilityContext<? extends org.apache.isis.applib.events.UsabilityEvent> ic)

Whether the rule represented by this facet disables the member to which it applies.

Implementations should use the provided InteractionContext to determine whether they disable the member from being modified or used. They must however guard against a null target and session - neither are guaranteed to be populated.