org.apache.isis.core.progmodel.facets.members.disabled

Class DisabledFacetAbstract

java.lang.Object

org.apache.isis.core.metamodel.facetapi.FacetAbstract

org.apache.isis.core.metamodel.facets.WhenValueFacetAbstract

org.apache.isis.core.metamodel.facets.WhenAndWhereValueFacetAbstract

org.apache.isis.core.progmodel.facets.members.disabled.DisabledFacetAbstract

All Implemented Interfaces:

InteractionAdvisor, Facet, FacetAbstract.Disabling, WhenAndWhereValueFacet, WhenValueFacet, DisablingInteractionAdvisor, InteractionAdvisorFacet, DisabledFacet

Direct Known Subclasses:

DisabledFacetAlwaysEverywhere, DisabledFacetForCollectionDerivedFromImmutable, DisabledFacetForPropertyDerivedFromImmutable, DisabledFacetImpl, DisabledFacetNever

public abstract class DisabledFacetAbstract
extends WhenAndWhereValueFacetAbstract
implements DisabledFacet

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.isis.core.metamodel.facetapi.FacetAbstract

FacetAbstract.Derivation, FacetAbstract.Disabling, FacetAbstract.Hiding, FacetAbstract.Validating

Field Summary

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

NOOP

Constructor Summary

Constructors

Constructor and Description
DisabledFacetAbstract(org.apache.isis.applib.annotation.When when, org.apache.isis.applib.annotation.Where where, FacetHolder holder)

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.
static Class<? extends Facet>	type()

Methods inherited from class org.apache.isis.core.metamodel.facets.WhenAndWhereValueFacetAbstract

toStringValues, where

Methods inherited from class org.apache.isis.core.metamodel.facets.WhenValueFacetAbstract

when

Methods inherited from class org.apache.isis.core.metamodel.facetapi.FacetAbstract

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.isis.core.progmodel.facets.members.disabled.DisabledFacet

disabledReason

Methods inherited from interface org.apache.isis.core.metamodel.facets.WhenAndWhereValueFacet

where

Methods inherited from interface org.apache.isis.core.metamodel.facets.WhenValueFacet

when

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

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

Constructor Detail

DisabledFacetAbstract

public DisabledFacetAbstract(org.apache.isis.applib.annotation.When when,
                     org.apache.isis.applib.annotation.Where where,
                     FacetHolder holder)

Method Detail

type

public static Class<? extends Facet> type()

disables

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

Description copied from interface: DisablingInteractionAdvisor

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.

Specified by:

disables in interface DisablingInteractionAdvisor