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

Interface ObjectAction

All Superinterfaces:

FacetHolder, IdentifiedHolder, ObjectFeature, ObjectMember, Specification

All Known Implementing Classes:

ObjectActionContributee, ObjectActionImpl

public interface ObjectAction
extends ObjectMember

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ObjectAction.Filters
static class	ObjectAction.Predicates
static class	ObjectAction.Utils

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.
ObjectAdapter	execute(ObjectAdapter target, ObjectAdapter[] parameters) 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.
ObjectAdapter[]	getDefaults(ObjectAdapter target) Returns the defaults references/values to be used for the action.
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() Returns set of parameter information.
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.
ActionType	getType()
boolean	hasReturn() Returns true if the represented action returns a non-void object, else returns false.
Consent	isProposedArgumentSetValid(ObjectAdapter object, ObjectAdapter[] proposedArguments) Whether the provided argument set is valid, represented as a Consent.
boolean	promptForParameters(ObjectAdapter target)

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

createUsableInteractionContext, createVisibleInteractionContext, debugData, getHelp, isAction, isAlwaysHidden, isOneToManyAssociation, isOneToOneAssociation, isPropertyOrCollection, isUsable, isVisible

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

getSemantics

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

The semantics of this action.

getOnType

ObjectSpecification getOnType()

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

promptForParameters

boolean promptForParameters(ObjectAdapter target)

getType

ActionType getType()

getReturnType

ObjectSpecification getReturnType()

Returns the specifications for the return type.

hasReturn

boolean hasReturn()

Returns true if the represented action returns a non-void object, else returns false.

execute

ObjectAdapter execute(ObjectAdapter target,
                    ObjectAdapter[] parameters)

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

createActionInvocationInteractionContext

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

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

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

isProposedArgumentSetValid

Consent isProposedArgumentSetValid(ObjectAdapter object,
                                 ObjectAdapter[] proposedArguments)

Whether the provided argument set is valid, represented as a Consent.

getParameterCount

int getParameterCount()

Returns the number of parameters used by this method.

getParameters

List<ObjectActionParameter> getParameters()

Returns set of parameter information.

Implementations may build this array lazily or eagerly as required.

Returns:

getParameterTypes

List<ObjectSpecification> getParameterTypes()

Returns the type of each of the parameters.

getParameters

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

Returns set of parameter information matching the supplied filter.

Returns:

getParameterById

ObjectActionParameter getParameterById(String paramId)

Returns the parameter with provided id.

getParameterByName

ObjectActionParameter getParameterByName(String paramName)

Returns the parameter with provided name.

getDefaults

ObjectAdapter[] getDefaults(ObjectAdapter target)

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

getChoices

ObjectAdapter[][] getChoices(ObjectAdapter target)

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