org.apache.isis.core.metamodel.specloader.specimpl

Class ObjectActionContributee

java.lang.Object

org.apache.isis.core.metamodel.specloader.specimpl.ObjectMemberAbstract

org.apache.isis.core.metamodel.specloader.specimpl.ObjectActionImpl

org.apache.isis.core.metamodel.specloader.specimpl.ObjectActionContributee

All Implemented Interfaces:

FacetHolder, IdentifiedHolder, ObjectAction, ObjectFeature, ObjectMember, Specification, ContributeeMember

public class ObjectActionContributee
extends ObjectActionImpl
implements ContributeeMember

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.isis.core.metamodel.specloader.specimpl.ContributeeMember

ContributeeMember.Predicates

Nested classes/interfaces inherited from interface org.apache.isis.core.metamodel.spec.feature.ObjectAction

ObjectAction.Filters, ObjectAction.Predicates, ObjectAction.Utils

Field Summary

Fields inherited from class org.apache.isis.core.metamodel.specloader.specimpl.ObjectMemberAbstract

defaultName

Constructor Summary

Constructors

Constructor and Description
ObjectActionContributee(ObjectAdapter serviceAdapter, ObjectActionImpl serviceAction, int contributeeParam, ObjectSpecification contributeeType, ObjectMemberContext objectMemberContext)

Method Summary

Methods

Modifier and Type	Method and Description
void	addFacet(Facet facet) Adds the facet, extracting its type as the key.
void	addFacet(MultiTypedFacet facet) Adds the multi-typed facet, extracting each of its types as keys.
boolean	containsDoOpFacet(Class<? extends Facet> facetType) Whether there is a facet registered of the specified type that is not a no-op.
boolean	containsFacet(Class<? extends Facet> facetType) Whether there is a facet registered of the specified type.
ObjectAdapter	execute(ObjectAdapter contributee, ObjectAdapter[] arguments) Invokes the action's method on the target object given the specified set of parameters.
ObjectAdapter[][]	getChoices(ObjectAdapter target) Returns a list of possible references/values for each parameter, which the user can choose from.
int	getContributeeParam()
ObjectAdapter[]	getDefaults(ObjectAdapter target) Returns the defaults references/values to be used for the action.
<T extends Facet> T	getFacet(Class<T> cls) Get the facet of the specified type (as per the type it reports from Facet.facetType()).
List<Facet>	getFacets(org.apache.isis.applib.filter.Filter<Facet> filter) Returns all Facets matching the specified FacetFilter.
Class<? extends Facet>[]	getFacetTypes() Get the list of all facet types that are supported by objects of this specification.
org.apache.isis.applib.Identifier	getIdentifier() Identifier of this feature.
ObjectSpecification	getOnType() Returns the specification for the type of object that this action can be invoked upon.
int	getParameterCount() Returns the number of parameters used by this method.
List<ObjectActionParameter>	getParameters() Build lazily by ObjectActionImpl.getParameters().
Consent	isProposedArgumentSetValid(ObjectAdapter contributee, ObjectAdapter[] proposedArguments) TODO: currently this method is hard-coded to assume all interactions are initiated by user.
Consent	isUsable(AuthenticationSession session, ObjectAdapter contributee, org.apache.isis.applib.annotation.Where where) Loops over all DisablingInteractionAdvisor Facets and returns true only if none disables the member.
Consent	isVisible(AuthenticationSession session, ObjectAdapter contributee, org.apache.isis.applib.annotation.Where where) Loops over all HidingInteractionAdvisor Facets and returns true only if none hide the member.
void	removeFacet(Class<? extends Facet> facetType) Remove the facet of the specified type.
void	removeFacet(Facet facet) Remove the facet whose type is that reported by Facet.facetType() .

Methods inherited from class org.apache.isis.core.metamodel.specloader.specimpl.ObjectActionImpl

createActionInvocationInteractionContext, createUsableInteractionContext, createVisibleInteractionContext, debugData, getActionInvocationFacet, getInstance, getParameterById, getParameterByName, getParameters, getParameterTypes, getReturnType, getSemantics, getSpecification, getType, getType, hasReturn, promptForParameters, toString

Methods inherited from class org.apache.isis.core.metamodel.specloader.specimpl.ObjectMemberAbstract

getAdapterManager, getAuthenticationSession, getAuthenticationSessionProvider, getCollectionTypeRegistry, getDeploymentCategory, getDescription, getFacetedMethod, getFeatureType, getHelp, getId, getName, getQuerySubmitter, getServicesProvider, getSpecification, getSpecificationLookup, isAction, isAlwaysHidden, isOneToManyAssociation, isOneToOneAssociation, isPropertyOrCollection

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.spec.feature.ObjectMember

getHelp, isAction, isAlwaysHidden, isOneToManyAssociation, isOneToOneAssociation, isPropertyOrCollection

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

getDescription, getId, getName

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

getFeatureType

Constructor Detail

ObjectActionContributee

public ObjectActionContributee(ObjectAdapter serviceAdapter,
                       ObjectActionImpl serviceAction,
                       int contributeeParam,
                       ObjectSpecification contributeeType,
                       ObjectMemberContext objectMemberContext)

Parameters:

contributeeParam - - the parameter number which corresponds to the contributee, and so should be suppressed.

Method Detail

getOnType

public ObjectSpecification getOnType()

Description copied from interface: ObjectAction

Returns the specification for the type of object that this action can be invoked upon.

Specified by:

getOnType in interface ObjectAction

Overrides:

getOnType in class ObjectActionImpl

getParameterCount

public int getParameterCount()

Description copied from interface: ObjectAction

Returns the number of parameters used by this method.

Specified by:

getParameterCount in interface ObjectAction

Overrides:

getParameterCount in class ObjectActionImpl

getContributeeParam

public int getContributeeParam()

getParameters

public List<ObjectActionParameter> getParameters()

Description copied from class: ObjectActionImpl

Build lazily by ObjectActionImpl.getParameters().

Although this is lazily loaded, the method is also synchronized so there shouldn't be any thread race conditions.

Specified by:

getParameters in interface ObjectAction

Overrides:

getParameters in class ObjectActionImpl

Returns:

isVisible

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

Description copied from class: ObjectMemberAbstract

Loops over all HidingInteractionAdvisor Facets and returns true only if none hide the member.

TODO: currently this method is hard-coded to assume all interactions are initiated by user.

Specified by:

isVisible in interface ObjectMember

Overrides:

isVisible in class ObjectMemberAbstract

contributee - may be null if just checking for authorization.

where - the member is being rendered in the UI

See Also:

#isVisibleResult(AuthenticationSession, ObjectAdapter)

isUsable

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

Description copied from class: ObjectMemberAbstract

Loops over all DisablingInteractionAdvisor Facets and returns true only if none disables the member.

TODO: currently this method is hard-coded to assume all interactions are initiated by user.

Specified by:

isUsable in interface ObjectMember

Overrides:

isUsable in class ObjectMemberAbstract

contributee - may be null if just checking for authorization.

where - the member is being rendered in the UI

See Also:

#isUsableResult(AuthenticationSession, ObjectAdapter)

getDefaults

public ObjectAdapter[] getDefaults(ObjectAdapter target)

Description copied from interface: ObjectAction

Returns the defaults references/values to be used for the action.

Specified by:

getDefaults in interface ObjectAction

Overrides:

getDefaults in class ObjectActionImpl

getChoices

public ObjectAdapter[][] getChoices(ObjectAdapter target)

Description copied from interface: ObjectAction

Returns a list of possible references/values for each parameter, which the user can choose from.

Specified by:

getChoices in interface ObjectAction

Overrides:

getChoices in class ObjectActionImpl

isProposedArgumentSetValid

public Consent isProposedArgumentSetValid(ObjectAdapter contributee,
                                 ObjectAdapter[] proposedArguments)

Description copied from class: ObjectActionImpl

TODO: currently this method is hard-coded to assume all interactions are initiated by user.

Specified by:

isProposedArgumentSetValid in interface ObjectAction

Overrides:

isProposedArgumentSetValid in class ObjectActionImpl

execute

public ObjectAdapter execute(ObjectAdapter contributee,
                    ObjectAdapter[] arguments)

Description copied from interface: ObjectAction

Invokes the action's method on the target object given the specified set of parameters.

Specified by:

execute in interface ObjectAction

Overrides:

execute in class ObjectActionImpl

getFacetTypes

public Class<? extends Facet>[] getFacetTypes()

Description copied from interface: FacetHolder

Get the list of all facet types that are supported by objects of this specification.

Specified by:

getFacetTypes in interface FacetHolder

Overrides:

getFacetTypes in class ObjectMemberAbstract

getFacet

public <T extends Facet> T getFacet(Class<T> cls)

Description copied from interface: FacetHolder

Get the facet of the specified type (as per the type it reports from Facet.facetType()).

Specified by:

getFacet in interface FacetHolder

Overrides:

getFacet in class ObjectMemberAbstract

containsFacet

public boolean containsFacet(Class<? extends Facet> facetType)

Description copied from interface: FacetHolder

Whether there is a facet registered of the specified type.

Specified by:

containsFacet in interface FacetHolder

Overrides:

containsFacet in class ObjectMemberAbstract

containsDoOpFacet

public boolean containsDoOpFacet(Class<? extends Facet> facetType)

Description copied from interface: FacetHolder

Whether there is a facet registered of the specified type that is not a no-op.

Convenience; saves having to FacetHolder.getFacet(Class) and then check if null and not a no-op.

Specified by:

containsDoOpFacet in interface FacetHolder

Overrides:

containsDoOpFacet in class ObjectMemberAbstract

getFacets

public List<Facet> getFacets(org.apache.isis.applib.filter.Filter<Facet> filter)

Description copied from interface: FacetHolder

Returns all Facets matching the specified FacetFilter.

Specified by:

getFacets in interface FacetHolder

Overrides:

getFacets in class ObjectMemberAbstract

Returns:

addFacet

public void addFacet(Facet facet)

Description copied from interface: FacetHolder

Adds the facet, extracting its type as the key.

If there are any facet of the same type, they will be overwritten provided that either the Facet specifies to always replace or if the existing Facet is a no-op.

Specified by:

addFacet in interface FacetHolder

Overrides:

addFacet in class ObjectMemberAbstract

addFacet

public void addFacet(MultiTypedFacet facet)

Description copied from interface: FacetHolder

Adds the multi-typed facet, extracting each of its types as keys.

If there are any facet of the same type, they will be overwritten provided that either the Facet specifies to always replace or if the existing Facet is a no-op.

Specified by:

addFacet in interface FacetHolder

Overrides:

addFacet in class ObjectMemberAbstract

removeFacet

public void removeFacet(Facet facet)

Description copied from interface: FacetHolder

Remove the facet whose type is that reported by Facet.facetType() .

Specified by:

removeFacet in interface FacetHolder

Overrides:

removeFacet in class ObjectMemberAbstract

removeFacet

public void removeFacet(Class<? extends Facet> facetType)

Description copied from interface: FacetHolder

Remove the facet of the specified type.

Specified by:

removeFacet in interface FacetHolder

Overrides:

removeFacet in class ObjectMemberAbstract

getIdentifier

public org.apache.isis.applib.Identifier getIdentifier()

Description copied from interface: IdentifiedHolder

Identifier of this feature.

Specified by:

getIdentifier in interface IdentifiedHolder

Overrides:

getIdentifier in class ObjectMemberAbstract