org.apache.isis.core.metamodel.spec.feature

Interface ObjectMember

All Superinterfaces:

FacetHolder, IdentifiedHolder, ObjectFeature, Specification

All Known Subinterfaces:

ObjectAction, ObjectAssociation, OneToManyAssociation, OneToOneAssociation

All Known Implementing Classes:

ObjectActionContributee, ObjectActionImpl, ObjectAssociationAbstract, ObjectMemberAbstract, OneToManyAssociationContributee, OneToManyAssociationImpl, OneToOneAssociationContributee, OneToOneAssociationImpl

public interface ObjectMember
extends ObjectFeature

Provides reflective access to an action or a field on a domain object.

Method Summary

Methods

Modifier and Type	Method and Description
UsabilityContext<?>	createUsableInteractionContext(AuthenticationSession session, InteractionInvocationMethod invocationMethod, ObjectAdapter target, org.apache.isis.applib.annotation.Where where) Create an InteractionContext to represent an attempt to use this member (that is, to check if it is usable or not).
VisibilityContext<?>	createVisibleInteractionContext(AuthenticationSession session, InteractionInvocationMethod invocationMethod, ObjectAdapter targetObjectAdapter, org.apache.isis.applib.annotation.Where where) Create an InteractionContext to represent an attempt to view this member (that is, to check if it is visible or not).
String	debugData()
String	getHelp() Return the help text for this member - the field or action - to complement the description.
boolean	isAction() Whether this member represents a ObjectAction.
boolean	isAlwaysHidden() When the member is always hidden.
boolean	isOneToManyAssociation() Whether this member represents a OneToManyAssociation.
boolean	isOneToOneAssociation() Whether this member represents a OneToOneAssociation.
boolean	isPropertyOrCollection() Whether this member represents a ObjectAssociation.
Consent	isUsable(AuthenticationSession session, ObjectAdapter target, org.apache.isis.applib.annotation.Where where) Determines whether this member is usable, represented as a Consent.
Consent	isVisible(AuthenticationSession session, ObjectAdapter target, org.apache.isis.applib.annotation.Where where) Determines if this member is visible, represented as a Consent.

Methods inherited from interface org.apache.isis.core.metamodel.spec.feature.ObjectFeature

getDescription, getId, getName, getSpecification

Methods inherited from interface org.apache.isis.core.metamodel.spec.Specification

getFeatureType, getInstance

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

getIdentifier

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

addFacet, addFacet, containsDoOpFacet, containsFacet, getFacet, getFacets, getFacetTypes, removeFacet, removeFacet

Method Detail

getHelp

String getHelp()

Return the help text for this member - the field or action - to complement the description.

See Also:

ObjectFeature.getDescription()

isAlwaysHidden

boolean isAlwaysHidden()

When the member is always hidden.

Determined as per the HiddenFacet being present and WhenValueFacet.when() returning When.ALWAYS, and WhenAndWhereValueFacet.where() returning When#ANYWHERE.

createVisibleInteractionContext

VisibilityContext<?> createVisibleInteractionContext(AuthenticationSession session,
                                                   InteractionInvocationMethod invocationMethod,
                                                   ObjectAdapter targetObjectAdapter,
                                                   org.apache.isis.applib.annotation.Where where)

Create an InteractionContext to represent an attempt to view this member (that is, to check if it is visible or not).

Typically it is easier to just call isVisible(AuthenticationSession, ObjectAdapter, Where) or #isVisibleResult(AuthenticationSession, ObjectAdapter); this is provided as API for symmetry with interactions (such as AccessContext accesses) have no corresponding vetoing methods.

isVisible

Consent isVisible(AuthenticationSession session,
                ObjectAdapter target,
                org.apache.isis.applib.annotation.Where where)

Determines if this member is visible, represented as a Consent.

Parameters:

target - may be null if just checking for authorization.

where - the member is being rendered in the UI

See Also:

#isVisibleResult(AuthenticationSession, ObjectAdapter)

createUsableInteractionContext

UsabilityContext<?> createUsableInteractionContext(AuthenticationSession session,
                                                 InteractionInvocationMethod invocationMethod,
                                                 ObjectAdapter target,
                                                 org.apache.isis.applib.annotation.Where where)

Create an InteractionContext to represent an attempt to use this member (that is, to check if it is usable or not).

Typically it is easier to just call isUsable(AuthenticationSession, ObjectAdapter, Where) or #isUsableResult(AuthenticationSession, ObjectAdapter); this is provided as API for symmetry with interactions (such as AccessContext accesses) have no corresponding vetoing methods.

isUsable

Consent isUsable(AuthenticationSession session,
               ObjectAdapter target,
               org.apache.isis.applib.annotation.Where where)

Determines whether this member is usable, represented as a Consent.

Parameters:

target - may be null if just checking for authorization.

where - the member is being rendered in the UI

See Also:

#isUsableResult(AuthenticationSession, ObjectAdapter)

isPropertyOrCollection

boolean isPropertyOrCollection()

Whether this member represents a ObjectAssociation.

If so, can be safely downcast to ObjectAssociation.

isOneToManyAssociation

boolean isOneToManyAssociation()

Whether this member represents a OneToManyAssociation.

If so, can be safely downcast to OneToManyAssociation.

isOneToOneAssociation

boolean isOneToOneAssociation()

Whether this member represents a OneToOneAssociation.

If so, can be safely downcast to OneToOneAssociation.

isAction

boolean isAction()

Whether this member represents a ObjectAction.

If so, can be safely downcast to ObjectAction.

debugData

String debugData()