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

Class ObjectActionImpl

java.lang.Object

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

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

All Implemented Interfaces:

FacetHolder, IdentifiedHolder, ObjectAction, ObjectFeature, ObjectMember, Specification

Direct Known Subclasses:

ObjectActionContributee

public class ObjectActionImpl
extends ObjectMemberAbstract
implements ObjectAction

Nested Class Summary

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
ObjectActionImpl(FacetedMethod facetedMethod, ObjectMemberContext objectMemberContext)

Method Summary

Methods

Modifier and Type	Method and Description
ActionInvocationContext	createActionInvocationInteractionContext(AuthenticationSession session, InteractionInvocationMethod invocationMethod, ObjectAdapter targetObject, ObjectAdapter[] proposedArguments) Creates an interaction context representing an attempt to invoke this action.
UsabilityContext<?>	createUsableInteractionContext(AuthenticationSession session, InteractionInvocationMethod invocationMethod, ObjectAdapter targetObjectAdapter, 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()
ObjectAdapter	execute(ObjectAdapter target, ObjectAdapter[] arguments) Invokes the action's method on the target object given the specified set of parameters.
protected ActionInvocationFacet	getActionInvocationFacet()
ObjectAdapter[][]	getChoices(ObjectAdapter target) Returns a list of possible references/values for each parameter, which the user can choose from.
ObjectAdapter[]	getDefaults(ObjectAdapter target) Returns the defaults references/values to be used for the action.
Instance	getInstance(ObjectAdapter adapter) Return an Instance of this Specification with respect to the provided ObjectAdapter.
ObjectSpecification	getOnType() Returns the specification for the type of object that this action can be invoked upon.
ObjectActionParameter	getParameterById(String paramId) Returns the parameter with provided id.
ObjectActionParameter	getParameterByName(String paramName) Returns the parameter with provided name.
int	getParameterCount() Returns the number of parameters used by this method.
List<ObjectActionParameter>	getParameters() Build lazily by getParameters().
List<ObjectActionParameter>	getParameters(org.apache.isis.applib.filter.Filter<ObjectActionParameter> filter) Returns set of parameter information matching the supplied filter.
List<ObjectSpecification>	getParameterTypes() Returns the type of each of the parameters.
ObjectSpecification	getReturnType() Returns the specifications for the return type.
org.apache.isis.applib.annotation.ActionSemantics.Of	getSemantics() The semantics of this action.
ObjectSpecification	getSpecification() Always returns null.
ActionType	getType()
static ActionType	getType(String typeStr)
boolean	hasReturn() Returns true if the represented action returns something, else returns false.
Consent	isProposedArgumentSetValid(ObjectAdapter target, ObjectAdapter[] proposedArguments) TODO: currently this method is hard-coded to assume all interactions are initiated by user.
boolean	promptForParameters(ObjectAdapter target)
String	toString()

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

addFacet, addFacet, containsDoOpFacet, containsFacet, getAdapterManager, getAuthenticationSession, getAuthenticationSessionProvider, getCollectionTypeRegistry, getDeploymentCategory, getDescription, getFacet, getFacetedMethod, getFacets, getFacetTypes, getFeatureType, getHelp, getId, getIdentifier, getName, getQuerySubmitter, getServicesProvider, getSpecification, getSpecificationLookup, isAction, isAlwaysHidden, isOneToManyAssociation, isOneToOneAssociation, isPropertyOrCollection, isUsable, isVisible, removeFacet, removeFacet

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, isUsable, isVisible

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

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

Constructor Detail

ObjectActionImpl

public ObjectActionImpl(FacetedMethod facetedMethod,
                ObjectMemberContext objectMemberContext)

Method Detail

getType

public static ActionType getType(String typeStr)

getSpecification

public ObjectSpecification getSpecification()

Always returns null.

Specified by:

getSpecification in interface ObjectFeature

getReturnType

public ObjectSpecification getReturnType()

Description copied from interface: ObjectAction

Returns the specifications for the return type.

Specified by:

getReturnType in interface ObjectAction

hasReturn

public boolean hasReturn()

Returns true if the represented action returns something, else returns false.

Specified by:

hasReturn in interface ObjectAction

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

getSemantics

public org.apache.isis.applib.annotation.ActionSemantics.Of getSemantics()

Description copied from interface: ObjectAction

The semantics of this action.

Specified by:

getSemantics in interface ObjectAction

getInstance

public Instance getInstance(ObjectAdapter adapter)

Description copied from interface: Specification

Return an Instance of this Specification with respect to the provided ObjectAdapter.

For example, if the Specification is a OneToOneAssociation, then is an Instance implementation representing the { ObjectAdapter/ OneToOneAssociation tuple.

Implementations are expected to use a double-dispatch back to the provided ObjectAdapter (passing themselves as a parameter), using ObjectAdapter.getInstance(Specification).

Note: this method may throw an UnsupportedOperationException; see ObjectAdapter.getInstance(Specification) for details.

Specified by:

getInstance in interface Specification

getType

public ActionType getType()

Specified by:

getType in interface ObjectAction

getParameterCount

public int getParameterCount()

Description copied from interface: ObjectAction

Returns the number of parameters used by this method.

Specified by:

getParameterCount in interface ObjectAction

promptForParameters

public boolean promptForParameters(ObjectAdapter target)

Specified by:

promptForParameters in interface ObjectAction

getParameters

public List<ObjectActionParameter> getParameters()

Build lazily by 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

Returns:

getParameterTypes

public List<ObjectSpecification> getParameterTypes()

Description copied from interface: ObjectAction

Returns the type of each of the parameters.

Specified by:

getParameterTypes in interface ObjectAction

getParameterById

public ObjectActionParameter getParameterById(String paramId)

Description copied from interface: ObjectAction

Returns the parameter with provided id.

Specified by:

getParameterById in interface ObjectAction

getParameterByName

public ObjectActionParameter getParameterByName(String paramName)

Description copied from interface: ObjectAction

Returns the parameter with provided name.

Specified by:

getParameterByName in interface ObjectAction

getParameters

public List<ObjectActionParameter> getParameters(org.apache.isis.applib.filter.Filter<ObjectActionParameter> filter)

Description copied from interface: ObjectAction

Returns set of parameter information matching the supplied filter.

Specified by:

getParameters in interface ObjectAction

Returns:

createVisibleInteractionContext

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

Description copied from interface: ObjectMember

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

Specified by:

createVisibleInteractionContext in interface ObjectMember

createUsableInteractionContext

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

Description copied from interface: ObjectMember

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

Specified by:

createUsableInteractionContext in interface ObjectMember

isProposedArgumentSetValid

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

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

Specified by:

isProposedArgumentSetValid in interface ObjectAction

createActionInvocationInteractionContext

public ActionInvocationContext createActionInvocationInteractionContext(AuthenticationSession session,
                                                               InteractionInvocationMethod invocationMethod,
                                                               ObjectAdapter targetObject,
                                                               ObjectAdapter[] proposedArguments)

Description copied from interface: ObjectAction

Creates an interaction context representing an attempt to invoke this action.

Typically it is easier to just call {@link #isProposedArgumentSetValid(ObjectAdapter, ObjectAdapter[])

Specified by:

createActionInvocationInteractionContext in interface ObjectAction

execute

public ObjectAdapter execute(ObjectAdapter target,
                    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

getActionInvocationFacet

protected ActionInvocationFacet getActionInvocationFacet()

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

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

debugData

public String debugData()

Specified by:

debugData in interface ObjectMember

toString

public String toString()

Overrides:

toString in class ObjectMemberAbstract