org.apache.isis.core.progmodel.facets.object.bounded

Class ChoicesFacetFromBoundedAbstract

java.lang.Object

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

org.apache.isis.core.progmodel.facets.object.bounded.ChoicesFacetFromBoundedAbstract

All Implemented Interfaces:

InteractionAdvisor, Facet, FacetAbstract.Disabling, FacetAbstract.Validating, ChoicesFacet, DisablingInteractionAdvisor, InteractionAdvisorFacet, ValidatingInteractionAdvisor

Direct Known Subclasses:

ChoicesFacetFromBoundedAnnotation, ChoicesFacetFromBoundedFacetMarkerInterface

public abstract class ChoicesFacetFromBoundedAbstract
extends FacetAbstract
implements ChoicesFacet, DisablingInteractionAdvisor, ValidatingInteractionAdvisor

A fixed number of choices because the number of instances of this class is bounded.

Typically viewers will interpret this information by displaying all instances of the class in a drop-down list box or similar widget.

In the standard Apache Isis Programming Model, corresponds to annotating the member with Bounded annotation or implementing the Bounded marker interface.

Nested Class Summary

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

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

Nested classes/interfaces inherited from interface org.apache.isis.core.metamodel.facets.choices.ChoicesFacet

ChoicesFacet.Util

Field Summary

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

NOOP

Constructor Summary

Constructors

Constructor and Description
ChoicesFacetFromBoundedAbstract(FacetHolder holder, QuerySubmitter querySubmitter)

Method Summary

Methods

Modifier and Type	Method and Description
String	disabledReason(ObjectAdapter inObject) Optional hook method for subclasses to override.
String	disables(UsabilityContext<? extends org.apache.isis.applib.events.UsabilityEvent> context) Whether the rule represented by this facet disables the member to which it applies.
Object[]	getChoices(ObjectAdapter adapter) Gets a set of choices for this object.
protected QuerySubmitter	getQuerySubmitter()
String	invalidates(ValidityContext<? extends org.apache.isis.applib.events.ValidityEvent> context) Whether the validation represented by this facet passes or fails.
static Class<? extends Facet>	type()

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

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

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.metamodel.facetapi.Facet

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

Constructor Detail

ChoicesFacetFromBoundedAbstract

public ChoicesFacetFromBoundedAbstract(FacetHolder holder,
                               QuerySubmitter querySubmitter)

Method Detail

type

public static Class<? extends Facet> type()

getQuerySubmitter

protected QuerySubmitter getQuerySubmitter()

invalidates

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

Description copied from interface: ValidatingInteractionAdvisor

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.

Specified by:

invalidates in interface ValidatingInteractionAdvisor

disables

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

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

disabledReason

public String disabledReason(ObjectAdapter inObject)

Optional hook method for subclasses to override.

getChoices

public Object[] getChoices(ObjectAdapter adapter)

Description copied from interface: ChoicesFacet

Gets a set of choices for this object.

Specified by:

getChoices in interface ChoicesFacet