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

Interface ObjectActionParameter

All Superinterfaces:

CurrentHolder, FacetHolder, IdentifiedHolder, ObjectFeature, Specification

All Known Subinterfaces:

ObjectActionParameterContributee, OneToOneActionParameter, ParseableEntryActionParameter

All Known Implementing Classes:

ObjectActionParameterAbstract, ObjectActionParameterParseable, ObjectActionParameterParseableContributee, OneToOneActionParameterContributee, OneToOneActionParameterImpl

public interface ObjectActionParameter
extends ObjectFeature, CurrentHolder

Analogous to ObjectAssociation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ObjectActionParameter.Filters

Method Summary

Methods

Modifier and Type	Method and Description
ActionArgumentContext	createProposedArgumentInteractionContext(AuthenticationSession session, InteractionInvocationMethod invocationMethod, ObjectAdapter targetObject, ObjectAdapter[] args, int position)
ObjectAction	getAction() Owning ObjectAction.
ObjectAdapter[]	getAutoComplete(ObjectAdapter adapter, String searchArg) Returns a list of possible references/values for this parameter, which the user can choose from, based on the input search argument.
int	getAutoCompleteMinLength()
ObjectAdapter[]	getChoices(ObjectAdapter adapter, ObjectAdapter[] argumentsIfAvailable) Returns a list of possible references/values for this parameter, which the user can choose from.
ObjectAdapter	getDefault(ObjectAdapter adapter)
String	getName() Returns the name of this parameter.
int	getNumber() Returns the 0-based index to this parameter.
boolean	hasAutoComplete() Whether there is an autoComplete provided (eg autoCompleteXxx supporting method) for the parameter.
boolean	hasChoices() Whether there are any choices provided (eg choicesXxx supporting method) for the parameter.
boolean	isCollection() Only for symmetry with ObjectAssociation, however since the NOF does not support collections as actions all implementations should return false.
boolean	isObject() If true then can cast to a OneToOneActionParameter.
boolean	isOptional() Returns a flag indicating if it can be left unset when the action can be invoked.
String	isValid(ObjectAdapter adapter, Object proposedValue, org.apache.isis.applib.profiles.Localization localization) Whether proposed value for this parameter is valid.

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

getDescription, getId, 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

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

get

Method Detail

isObject

boolean isObject()

If true then can cast to a OneToOneActionParameter.

Either this or isCollection() will be true.

Design note: modelled after ObjectAssociation#isNotCollection()

isCollection

boolean isCollection()

Only for symmetry with ObjectAssociation, however since the NOF does not support collections as actions all implementations should return false.

getAction

ObjectAction getAction()

Owning ObjectAction.

isOptional

boolean isOptional()

Returns a flag indicating if it can be left unset when the action can be invoked.

getNumber

int getNumber()

Returns the 0-based index to this parameter.

getName

String getName()

Returns the name of this parameter.

Because Java's reflection API does not allow us to access the code name of the parameter, we have to do figure out the name of the parameter ourselves:

• If there is a NamedFacet associated with this parameter then we infer a name from this, eg "First Name" becomes "firstName".
• Otherwise we use the type, eg "string".
• If there is more than one parameter of the same type, then we use a numeric suffix (eg "string1", "string2"). Wrappers and primitives are considered to be the same type.

Specified by:

getName in interface ObjectFeature

See Also:

IdentifiedHolder.getIdentifier()

createProposedArgumentInteractionContext

ActionArgumentContext createProposedArgumentInteractionContext(AuthenticationSession session,
                                                             InteractionInvocationMethod invocationMethod,
                                                             ObjectAdapter targetObject,
                                                             ObjectAdapter[] args,
                                                             int position)

hasAutoComplete

boolean hasAutoComplete()

Whether there is an autoComplete provided (eg autoCompleteXxx supporting method) for the parameter.

getAutoComplete

ObjectAdapter[] getAutoComplete(ObjectAdapter adapter,
                              String searchArg)

Returns a list of possible references/values for this parameter, which the user can choose from, based on the input search argument.

getAutoCompleteMinLength

int getAutoCompleteMinLength()

hasChoices

boolean hasChoices()

Whether there are any choices provided (eg choicesXxx supporting method) for the parameter.

getChoices

ObjectAdapter[] getChoices(ObjectAdapter adapter,
                         ObjectAdapter[] argumentsIfAvailable)

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

getDefault

ObjectAdapter getDefault(ObjectAdapter adapter)

isValid

String isValid(ObjectAdapter adapter,
             Object proposedValue,
             org.apache.isis.applib.profiles.Localization localization)

Whether proposed value for this parameter is valid.

Parameters:

adapter -

proposedValue -

Returns: