org.apache.isis.core.metamodel.facetapi

Interface Facet

All Known Subinterfaces:

ActionChoicesFacet, ActionDefaultsFacet, ActionInvocationFacet, ActionOrderFacet, ActionParameterAutoCompleteFacet, ActionParameterChoicesFacet, ActionParameterDefaultsFacet, ActionSemanticsFacet, ActionValidationFacet, AuditableFacet, AuthorizationFacet, AutoCompleteFacet, BigDecimalValueFacet, BigIntegerValueFacet, BlobValueFacet, BookmarkPolicyFacet, BooleanValueFacet, BulkFacet, BusinessKeyFacet, ByteValueFacet, CachedFacet, CallbackFacet, CharValueFacet, ChoicesFacet, ClearDirtyObjectFacet, ClobValueFacet, CollectionAddToFacet, CollectionClearFacet, CollectionFacet, CollectionRemoveFromFacet, CollectionValidateAddToFacet, CollectionValidateRemoveFromFacet, ColorValueFacet, CommandFacet, CreatedCallbackFacet, CssClassFacet, DateValueFacet, DebugFacet, DefaultedFacet, DescribedAsFacet, DirtyObjectFacet, DisabledFacet, DisabledObjectFacet, DisableForContextFacet, DisableForSessionFacet, DisablingInteractionAdvisor, DoubleFloatingPointValueFacet, EncodableFacet, EnumFacet, EqualByContentFacet, ExplorationFacet, FacetsFacet, FieldOrderFacet, FloatingPointValueFacet, HelpFacet, HiddenFacet, HiddenObjectFacet, HideForContextFacet, HideForSessionFacet, HidingInteractionAdvisor, HomePageFacet, IconFacet, ImageValueFacet, ImmutableFacet, IntegerValueFacet, InteractionAdvisorFacet, IsDirtyObjectFacet, JodaDateTimeValueFacet, JodaLocalDateTimeValueFacet, JodaLocalDateValueFacet, LoadedCallbackFacet, LoadingCallbackFacet, LongValueFacet, MandatoryFacet, MarkDirtyObjectFacet, MarkerFacet, MaskFacet, MaxLengthFacet, MemberGroupLayoutFacet, MemberOrderFacet, MoneyValueFacet, MultiLineFacet, MultipleValueFacet, MultiTypedFacet, NamedFacet, NotContributedFacet, NotInServiceMenuFacet, NotPersistableFacet, NotPersistedFacet, ObjectSpecIdFacet, ObjectValidPropertiesFacet, PagedFacet, ParentedFacet, ParseableFacet, PasswordValueFacet, PersistedCallbackFacet, PersistingCallbackFacet, PluralFacet, PostsActionInvokedEventFacet, PostsCollectionAddedToEventFacet, PostsCollectionRemovedFromEventFacet, PostsPropertyChangedEventClearFacet, PostsPropertyChangedEventSetterFacet, PropertyAutoCompleteFacet, PropertyChoicesFacet, PropertyClearFacet, PropertyDefaultFacet, PropertyInitializationFacet, PropertyOrCollectionAccessorFacet, PropertySetterFacet, PropertyValidateFacet, PrototypeFacet, PublishedActionFacet, PublishedObjectFacet, RegExFacet, RemovedCallbackFacet, RemovingCallbackFacet, RenderedAdjustedFacet, RenderFacet, SearchableFacet, ShortValueFacet, SingleClassValueFacet, SingleIntValueFacet, SingleStringValueFacet, SingleValueFacet<T>, SortedByFacet, StringValueFacet, TitleFacet, TypeOfFacet, TypicalLengthFacet, UpdatedCallbackFacet, UpdatingCallbackFacet, URLValueFacet, UUIDValueFacet, ValidateObjectFacet, ValidatingInteractionAdvisor, ValueFacet, ViewModelFacet, WhenAndWhereValueFacet, WhenValueFacet

All Known Implementing Classes:

ActionChoicesFacetAbstract, ActionChoicesFacetNone, ActionChoicesFacetViaMethod, ActionDefaultsFacetAbstract, ActionDefaultsFacetNone, ActionDefaultsFacetViaMethod, ActionInvocationFacetAbstract, ActionInvocationFacetViaMethod, ActionOrderFacetAbstract, ActionOrderFacetAnnotation, ActionParameterAutoCompleteFacetAbstract, ActionParameterAutoCompleteFacetViaMethod, ActionParameterChoicesFacetAbstract, ActionParameterChoicesFacetDerivedFromChoicesFacet, ActionParameterChoicesFacetNone, ActionParameterChoicesFacetViaMethod, ActionParameterDefaultFacetDerivedFromTypeFacets, ActionParameterDefaultsFacetAbstract, ActionParameterDefaultsFacetNone, ActionParameterDefaultsFacetViaMethod, ActionSemanticsFacetAbstract, ActionSemanticsFacetAnnotation, ActionSemanticsFacetFallbackToNonIdempotent, ActionValidationFacetAbstract, ActionValidationFacetViaMethod, AuditableFacetAbstract, AuditableFacetAuditedAnnotation, AuditableFacetFromConfiguration, AuditableFacetImpl, AuditableFacetMarkerInterface, AuthorizationFacetAbstract, AuthorizationFacetImpl, AutoCompleteFacetAbstract, AutoCompleteFacetAnnotation, BigDecimalFacetForParameterFromJavaxValidationDigitsAnnotation, BigDecimalFacetForPropertyFromJavaxValidationDigitsAnnotation, BigDecimalValueFacetAbstract, BigDecimalValueSemanticsProvider, BigIntegerValueSemanticsProvider, BlobValueSemanticsProvider, BookmarkPolicyFacetAbstract, BookmarkPolicyFacetFallback, BookmarkPolicyFacetViaBookmarkableAnnotation, BooleanPrimitiveValueSemanticsProvider, BooleanValueSemanticsProviderAbstract, BooleanWrapperValueSemanticsProvider, BulkFacetAbstract, BulkFacetAnnotation, BusinessKeyFacetAbstract, BytePrimitiveValueSemanticsProvider, ByteValueSemanticsProviderAbstract, ByteWrapperValueSemanticsProvider, CachedFacetAbstract, CallbackFacetAbstract, CharPrimitiveValueSemanticsProvider, CharValueSemanticsProviderAbstract, CharWrapperValueSemanticsProvider, ChoicesFacetAbstract, ChoicesFacetEnum, ChoicesFacetFromBoundedAbstract, ChoicesFacetFromBoundedAnnotation, ChoicesFacetFromBoundedFacetMarkerInterface, ClearDirtyObjectFacetAbstract, ClearDirtyObjectFacetViaMethod, ClobValueSemanticsProvider, CollectionAccessorFacetViaAccessor, CollectionAddToFacetAbstract, CollectionAddToFacetViaAccessor, CollectionAddToFacetViaMethod, CollectionClearFacetAbstract, CollectionClearFacetViaAccessor, CollectionClearFacetViaMethod, CollectionFacetAbstract, CollectionFacetForFreeStandingList, CollectionRemoveFromFacetAbstract, CollectionRemoveFromFacetViaAccessor, CollectionRemoveFromFacetViaMethod, CollectionValidateAddToFacetAbstract, CollectionValidateAddToFacetViaMethod, CollectionValidateRemoveFromFacetAbstract, CollectionValidateRemoveFromFacetViaMethod, ColorValueSemanticsProvider, CommandFacetAbstract, CommandFacetAnnotation, CommandFacetFromConfiguration, CreatedCallbackFacetAbstract, CreatedCallbackFacetViaMethod, CssClassFacetAbstract, CssClassFacetForTypeAnnotation, CssClassFacetOnMemberAnnotation, CssClassFacetOnMemberFromProperties, DateAndTimeValueSemanticsProviderAbstract, DateTimeValueSemanticsProvider, DateValueSemanticsProvider, DateValueSemanticsProviderAbstract, DebugFacetAbstract, DebugFacetAnnotation, DebugFacetViaNamingConvention, DefaultedFacetAbstract, DefaultedFacetAnnotation, DefaultedFacetFromConfiguration, DefaultedFacetUsingDefaultsProvider, DescribedAsFacetAbstract, DescribedAsFacetAnnotationOnParameter, DescribedAsFacetAnnotationOnType, DescribedAsFacetForMemberDerivedFromType, DescribedAsFacetForObjectList, DescribedAsFacetForParameterDerivedFromType, DescribedAsFacetNone, DescribedAsFacetOnMemberAnnotation, DescribedAsFacetOnMemberFromProperties, DescribedAsFacetViaMethod, DescribedAsFacetWrapI18n, DirtyObjectFacetAbstract, DisabledFacetAbstract, DisabledFacetAlwaysEverywhere, DisabledFacetAnnotation, DisabledFacetForCollectionDerivedFromImmutable, DisabledFacetForPropertyDerivedFromImmutable, DisabledFacetFromProperties, DisabledFacetImpl, DisabledFacetNever, DisabledObjectFacetAbstract, DisabledObjectFacetViaDisabledMethod, DisableForContextFacetAbstract, DisableForContextFacetNone, DisableForContextFacetViaMethod, DisableForSessionFacetAbstract, DisableForSessionFacetNone, DisableForSessionFacetViaMethod, DoublePrimitiveValueSemanticsProvider, DoubleValueSemanticsProviderAbstract, DoubleWrapperValueSemanticsProvider, EncodableFacetAbstract, EncodableFacetAnnotation, EncodableFacetFromConfiguration, EncodableFacetUsingEncoderDecoder, EnumValueSemanticsProvider, EqualByContentFacetAbstract, EqualByContentFacetViaValueSemantics, ExplorationFacetAbstract, ExplorationFacetAnnotation, ExplorationFacetViaNamingConvention, FacetAbstract, FacetsFacetAbstract, FacetsFacetAnnotation, FieldOrderFacetAbstract, FieldOrderFacetAnnotation, FloatPrimitiveValueSemanticsProvider, FloatValueSemanticsProviderAbstract, FloatWrapperValueSemanticsProvider, HelpFacetAbstract, HelpFacetLookedUpViaHelpManager, HelpFacetNone, HelpFacetWrapI18n, HiddenFacetAbstract, HiddenFacetAlwaysEverywhere, HiddenFacetForTypeAnnotation, HiddenFacetImpl, HiddenFacetNever, HiddenFacetOnMemberAnnotation, HiddenFacetOnMemberFromProperties, HiddenObjectFacetAbstract, HiddenObjectFacetViaHiddenMethod, HideForContextFacetAbstract, HideForContextFacetNone, HideForContextFacetViaMethod, HideForSessionFacetAbstract, HideForSessionFacetNone, HideForSessionFacetViaMethod, HomePageFacetAbstract, HomePageFacetAnnotation, HomePageFacetImpl, IconFacetAbstract, IconFacetViaMethod, IdempotentFacetAnnotation, ImageValueSemanticsProvider, ImageValueSemanticsProviderAbstract, ImmutableFacetAbstract, ImmutableFacetAnnotation, ImmutableFacetMarkerInterface, ImmutableFacetViaValueSemantics, IntPrimitiveValueSemanticsProvider, IntValueSemanticsProviderAbstract, IntWrapperValueSemanticsProvider, IsDirtyObjectFacetAbstract, IsDirtyObjectFacetViaMethod, JavaArrayFacet, JavaAwtImageValueSemanticsProvider, JavaCollectionFacet, JavaSqlDateValueSemanticsProvider, JavaSqlTimeStampValueSemanticsProvider, JavaSqlTimeValueSemanticsProvider, JavaUtilDateValueSemanticsProvider, JodaDateTimeValueSemanticsProvider, JodaDateTimeValueSemanticsProviderAbstract, JodaLocalDateTimeValueSemanticsProvider, JodaLocalDateValueSemanticsProvider, LoadedCallbackFacetAbstract, LoadedCallbackFacetViaMethod, LoadingCallbackFacetAbstract, LoadingCallbackFacetViaMethod, LongPrimitiveValueSemanticsProvider, LongValueSemanticsProviderAbstract, LongWrapperValueSemanticsProvider, MandatoryFacetAbstract, MandatoryFacetDefault, MandatoryFacetExplicitForProperty, MandatoryFacetInvertedByOptionalForParameter, MandatoryFacetInvertedByOptionalForProperty, MandatoryFacetOptionalViaMethodForParameter, MandatoryFacetOptionalViaMethodForProperty, MarkDirtyObjectFacetAbstract, MarkDirtyObjectFacetViaMethod, MarkerFacetAbstract, MaskFacetAbstract, MaskFacetAnnotationForParameter, MaskFacetAnnotationForProperty, MaskFacetAnnotationForType, MaxLengthFacetAbstract, MaxLengthFacetAnnotationForParameter, MaxLengthFacetAnnotationForProperty, MaxLengthFacetAnnotationForType, MaxLengthFacetUnlimited, MemberGroupLayoutFacetAbstract, MemberGroupLayoutFacetAnnotation, MemberGroupLayoutFacetFallback, MemberGroupLayoutFacetProperties, MemberGroupsFacetAnnotation, MemberOrderFacetAbstract, MemberOrderFacetAnnotation, MemberOrderFacetProperties, MoneyValueSemanticsProvider, MultiLineFacetAbstract, MultiLineFacetAnnotationOnParameter, MultiLineFacetAnnotationOnType, MultiLineFacetNone, MultiLineFacetOnPropertyAnnotation, MultiLineFacetOnPropertyFromProperties, MultipleValueFacetAbstract, MultiTypedFacetAbstract, MustSatisfySpecificationOnParameterFacet, MustSatisfySpecificationOnPropertyFacet, MustSatisfySpecificationOnTypeFacet, NamedFacetAbstract, NamedFacetAnnotationOnParameter, NamedFacetAnnotationOnType, NamedFacetForObjectList, NamedFacetInferred, NamedFacetNone, NamedFacetOnMemberAnnotation, NamedFacetOnMemberFromProperties, NamedFacetViaMethod, NamedFacetViaSingularNameStaticMethod, NamedFacetWrapI18n, NotContributedFacetAbstract, NotContributedFacetAnnotation, NotInServiceMenuFacetAbstract, NotInServiceMenuFacetAnnotation, NotInServiceMenuFacetMethod, NotPersistableFacetAbstract, NotPersistableFacetAnnotation, NotPersistableFacetImpl, NotPersistableFacetInferred, NotPersistableFacetMarkerInterface, NotPersistableFacetNull, NotPersistedFacetAbstract, NotPersistedFacetAnnotationForCollection, NotPersistedFacetAnnotationForProperty, ObjectSpecIdFacetAbstract, ObjectSpecIdFacetDerivedFromClassName, ObjectSpecIdFacetForObjectTypeAnnotation, ObjectValidPropertiesFacetAbstract, ObjectValidPropertiesFacetImpl, PagedFacetAbstract, PagedFacetAnnotation, PagedFacetDefault, PagedFacetProperties, ParentedFacetAbstract, ParentedFacetSinceAggregatedAnnotation, ParentedFacetSinceCollection, ParseableFacetAbstract, ParseableFacetAnnotation, ParseableFacetFromConfiguration, ParseableFacetUsingParser, PasswordValueSemanticsProvider, PercentageValueSemanticsProvider, PersistedCallbackFacetAbstract, PersistedCallbackFacetViaMethod, PersistingCallbackFacetAbstract, PersistingCallbackFacetViaMethod, PluralFacetAbstract, PluralFacetAnnotation, PluralFacetForObjectList, PluralFacetInferred, PluralFacetViaMethod, PostsActionInvokedEventFacetAbstract, PostsActionInvokedEventFacetAnnotation, PostsCollectionAddedToEventFacetAbstract, PostsCollectionAddedToEventFacetAnnotation, PostsCollectionRemovedFromEventFacetAbstract, PostsCollectionRemovedFromEventFacetAnnotation, PostsPropertyChangedEventClearFacetAbstract, PostsPropertyChangedEventClearFacetAnnotation, PostsPropertyChangedEventSetterFacetAbstract, PostsPropertyChangedEventSetterFacetAnnotation, PropertyAccessorFacetViaAccessor, PropertyAutoCompleteFacetAbstract, PropertyAutoCompleteFacetViaMethod, PropertyChoicesFacetAbstract, PropertyChoicesFacetDerivedFromChoicesFacet, PropertyChoicesFacetViaMethod, PropertyClearFacetAbstract, PropertyClearFacetViaClearMethod, PropertyClearFacetViaSetterMethod, PropertyDefaultFacetAbstract, PropertyDefaultFacetDerivedFromDefaultedFacet, PropertyDefaultFacetNone, PropertyDefaultFacetViaMethod, PropertyInitializationFacetAbstract, PropertyInitializationFacetViaSetterMethod, PropertyOrCollectionAccessorFacetAbstract, PropertySetterFacetAbstract, PropertySetterFacetViaModifyMethod, PropertySetterFacetViaSetterMethod, PropertyValidateFacetAbstract, PropertyValidateFacetDefault, PropertyValidateFacetNone, PropertyValidateFacetViaMethod, PrototypeFacetAbstract, PrototypeFacetAnnotation, PublishedActionFacetAbstract, PublishedActionFacetAnnotation, PublishedObjectFacetAbstract, PublishedObjectFacetAnnotation, QueryOnlyFacetAnnotation, RegExFacetAbstract, RegExFacetAnnotationForParameter, RegExFacetAnnotationForProperty, RegExFacetAnnotationForType, RemovedCallbackFacetAbstract, RemovedCallbackFacetViaMethod, RemovingCallbackFacetAbstract, RemovingCallbackFacetViaMethod, RenderedAdjustedFacetAbstract, RenderedAsDayBeforeFacetAnnotationOnParameter, RenderedAsDayBeforeFacetAnnotationOnProperty, RenderFacetAbstract, RenderFacetAnnotation, RenderFacetProperties, RenderFacetViaResolveAnnotation, SearchableFacetAbstract, ShortPrimitiveValueSemanticsProvider, ShortValueSemanticsProviderAbstract, ShortWrapperValueSemanticsProvider, SingleClassValueFacetAbstract, SingleIntValueFacetAbstract, SingleStringValueFacetAbstract, SingleValueFacetAbstract, SortedByFacetAbstract, SortedByFacetAnnotation, StringValueSemanticsProvider, TimeStampValueSemanticsProvider, TimeStampValueSemanticsProviderAbstract, TimeValueSemanticsProvider, TimeValueSemanticsProviderAbstract, TitleFacetAbstract, TitleFacetBasedOnMask, TitleFacetFormattedByRegex, TitleFacetNone, TitleFacetUsingParser, TitleFacetViaTitleAnnotation, TitleFacetViaTitleMethod, TitleFacetViaToStringMethod, TypeOfFacetAbstract, TypeOfFacetAnnotationForAction, TypeOfFacetAnnotationForCollection, TypeOfFacetDefaultToObject, TypeOfFacetInferredFromArray, TypeOfFacetInferredFromGenerics, TypeOfFacetInferredFromSupportingMethods, TypicalLengthFacetAbstract, TypicalLengthFacetAnnotationOnParameter, TypicalLengthFacetAnnotationOnType, TypicalLengthFacetForParameterDerivedFromType, TypicalLengthFacetForPropertyDerivedFromType, TypicalLengthFacetOnPropertyAnnotation, TypicalLengthFacetOnPropertyFromProperties, TypicalLengthFacetUsingParser, UpdatedCallbackFacetAbstract, UpdatedCallbackFacetViaMethod, UpdatingCallbackFacetAbstract, UpdatingCallbackFacetViaMethod, URLValueSemanticsProvider, UUIDValueSemanticsProvider, ValidateObjectFacetAbstract, ValidateObjectFacetViaValidateMethod, ValueFacetAbstract, ValueFacetAnnotation, ValueFacetFromConfiguration, ValueFacetUsingSemanticsProvider, ValueSemanticsProviderAbstractTemporal, ValueSemanticsProviderAndFacetAbstract, ViewModelFacetAbstract, ViewModelFacetForInterface, WhenAndWhereValueFacetAbstract, WhenValueFacetAbstract

public interface Facet

Method Summary

Methods

Modifier and Type	Method and Description
boolean	alwaysReplace() Whether this facet implementation should replace existing (none-noop) implementations.
Class<? extends Facet>	facetType() Determines the type of this facet to be stored under.
FacetHolder	getFacetHolder() The holder of this facet.
Facet	getUnderlyingFacet() Underlying Facet of the same type, if any.
boolean	isDerived() Whether this facet implementation is derived (as opposed to explicit); used to determine precedence.
boolean	isNoop() Whether this facet implementation is a no-op.
void	setFacetHolder(FacetHolder facetHolder) Allows reparenting of Facet.
void	setUnderlyingFacet(Facet underlyingFacet) Sets underlying Facet, that is, creating a chain.

Method Detail

getFacetHolder

FacetHolder getFacetHolder()

The holder of this facet.

Returns:

setFacetHolder

void setFacetHolder(FacetHolder facetHolder)

Allows reparenting of Facet.

Used by Facet decorators.

Parameters:

facetHolder -

getUnderlyingFacet

Facet getUnderlyingFacet()

Underlying Facet of the same type, if any.

setUnderlyingFacet

void setUnderlyingFacet(Facet underlyingFacet)

Sets underlying Facet, that is, creating a chain.

Must be of the same type.

facetType

Class<? extends Facet> facetType()

Determines the type of this facet to be stored under.

The framework looks for Facets of certain well-known facet types. Each facet implementation must specify which type of facet it corresponds to. This therefore allows the (rules of the) programming model to be varied without impacting the rest of the framework.

For example, the ActionInvocationFacet specifies the facet to invoke an action. The typical implementation of this wraps a public method. However, a different facet factory could be installed that creates facet also of type ActionInvocationFacet but that have some other rule, such as requiring an action prefix, or that decorate the interaction by logging it, for example.

isDerived

boolean isDerived()

Whether this facet implementation is derived (as opposed to explicit); used to determine precedence.

For example, we might derive the typical length of a property based on its type; but if the typical length has been explicitly specified using an annotation then that should take precedence.

isNoop

boolean isNoop()

Whether this facet implementation is a no-op.

alwaysReplace

boolean alwaysReplace()

Whether this facet implementation should replace existing (none-noop) implementations.