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

Class ObjectActionParameterAbstract

java.lang.Object

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

All Implemented Interfaces:

FacetHolder, IdentifiedHolder, CurrentHolder, ObjectActionParameter, ObjectFeature, Specification

Direct Known Subclasses:

ObjectActionParameterParseable, OneToOneActionParameterImpl

public abstract class ObjectActionParameterAbstract
extends Object
implements ObjectActionParameter

Nested Class Summary

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

ObjectActionParameter.Filters

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ObjectActionParameterAbstract(int number, ObjectActionImpl objectAction, TypedHolder peer)

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.
protected List<ObjectAdapter>	argsForDefaultOrChoices(ObjectAdapter adapter, List<ObjectAdapter> argumentsIfAvailable) Hook method; contributed action parameters override.
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.
ActionArgumentContext	createProposedArgumentInteractionContext(AuthenticationSession session, InteractionInvocationMethod invocationMethod, ObjectAdapter targetObject, ObjectAdapter[] proposedArguments, int position)
protected ObjectAdapter	doCoerceProposedValue(ObjectAdapter adapter, Object proposedValue, org.apache.isis.applib.profiles.Localization localization) Optional hook for parsing.
ObjectAction	getAction() Owning ObjectAction.
protected AdapterManager	getAdapterMap()
protected AuthenticationSession	getAuthenticationSession()
protected AuthenticationSessionProvider	getAuthenticationSessionProvider()
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	getDescription() Returns a description of how the member is used - this complements the help text.
<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.
String	getId() Returns the identifier of the member, which must not change.
org.apache.isis.applib.Identifier	getIdentifier() Identifier of this feature.
String	getName() Returns the name of this parameter.
int	getNumber() Parameter number, 0-based.
TypedHolder	getPeer() NOT API, but exposed for the benefit of ObjectActionParameterContributee.
protected QuerySubmitter	getQuerySubmitter()
ObjectSpecification	getSpecification() The specification of the underlying type.
protected SpecificationLoader	getSpecificationLookup()
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() Subclasses should override either isObject() or isCollection().
boolean	isObject() Subclasses should override either isObject() or isCollection().
boolean	isOptional() Returns a flag indicating if it can be left unset when the action can be invoked.
Consent	isUsable()
String	isValid(ObjectAdapter adapter, Object proposedValue, org.apache.isis.applib.profiles.Localization localization) Whether proposed value for this parameter is valid.
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() .
protected ObjectAdapter	targetForDefaultOrChoices(ObjectAdapter adapter, List<ObjectAdapter> argumentsIfAvailable) Hook method; contributed action parameters override.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getFeatureType, getInstance

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

get

Constructor Detail

ObjectActionParameterAbstract

protected ObjectActionParameterAbstract(int number,
                             ObjectActionImpl objectAction,
                             TypedHolder peer)

Method Detail

isObject

public boolean isObject()

Subclasses should override either isObject() or isCollection().

Specified by:

isObject in interface ObjectActionParameter

isCollection

public boolean isCollection()

Subclasses should override either isObject() or isCollection().

Specified by:

isCollection in interface ObjectActionParameter

getNumber

public int getNumber()

Parameter number, 0-based.

Specified by:

getNumber in interface ObjectActionParameter

getAction

public ObjectAction getAction()

Description copied from interface: ObjectActionParameter

Owning ObjectAction.

Specified by:

getAction in interface ObjectActionParameter

getPeer

public TypedHolder getPeer()

NOT API, but exposed for the benefit of ObjectActionParameterContributee.

getSpecification

public ObjectSpecification getSpecification()

Description copied from interface: ObjectFeature

The specification of the underlying type.

For example:

• for a property, will return the ObjectSpecification of the type that the accessor returns.
• for a collection it will be the type of element the collection holds (not the type of collection).
• for a action, will always return null. See instead ObjectAction.getReturnType() and ObjectAction.getParameterTypes().
• for a action, will return the type of the parameter}.

Specified by:

getSpecification in interface ObjectFeature

getIdentifier

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

Description copied from interface: IdentifiedHolder

Identifier of this feature.

Specified by:

getIdentifier in interface IdentifiedHolder

getId

public String getId()

Description copied from interface: ObjectFeature

Returns the identifier of the member, which must not change. This should be all camel-case with no spaces: so if the member is called 'Return Date' then a suitable id would be 'returnDate'.

Specified by:

getId in interface ObjectFeature

getName

public String getName()

Description copied from interface: ObjectActionParameter

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 ObjectActionParameter

Specified by:

getName in interface ObjectFeature

See Also:

IdentifiedHolder.getIdentifier()

getDescription

public String getDescription()

Description copied from interface: ObjectFeature

Returns a description of how the member is used - this complements the help text.

Specified by:

getDescription in interface ObjectFeature

Specified by:

getDescription in interface Specification

See Also:

#getHelp()

isOptional

public boolean isOptional()

Description copied from interface: ObjectActionParameter

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

Specified by:

isOptional in interface ObjectActionParameter

isUsable

public Consent isUsable()

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

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

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

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

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

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

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

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

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

hasAutoComplete

public boolean hasAutoComplete()

Description copied from interface: ObjectActionParameter

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

Specified by:

hasAutoComplete in interface ObjectActionParameter

getAutoComplete

public ObjectAdapter[] getAutoComplete(ObjectAdapter adapter,
                              String searchArg)

Description copied from interface: ObjectActionParameter

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

Specified by:

getAutoComplete in interface ObjectActionParameter

getAutoCompleteMinLength

public int getAutoCompleteMinLength()

Specified by:

getAutoCompleteMinLength in interface ObjectActionParameter

hasChoices

public boolean hasChoices()

Description copied from interface: ObjectActionParameter

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

Specified by:

hasChoices in interface ObjectActionParameter

getChoices

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

Description copied from interface: ObjectActionParameter

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

Specified by:

getChoices in interface ObjectActionParameter

getDefault

public ObjectAdapter getDefault(ObjectAdapter adapter)

Specified by:

getDefault in interface ObjectActionParameter

targetForDefaultOrChoices

protected ObjectAdapter targetForDefaultOrChoices(ObjectAdapter adapter,
                                      List<ObjectAdapter> argumentsIfAvailable)

Hook method; contributed action parameters override.

argsForDefaultOrChoices

protected List<ObjectAdapter> argsForDefaultOrChoices(ObjectAdapter adapter,
                                          List<ObjectAdapter> argumentsIfAvailable)

Hook method; contributed action parameters override.

createProposedArgumentInteractionContext

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

Specified by:

createProposedArgumentInteractionContext in interface ObjectActionParameter

isValid

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

Description copied from interface: ObjectActionParameter

Whether proposed value for this parameter is valid.

Specified by:

isValid in interface ObjectActionParameter

Returns:

doCoerceProposedValue

protected ObjectAdapter doCoerceProposedValue(ObjectAdapter adapter,
                                  Object proposedValue,
                                  org.apache.isis.applib.profiles.Localization localization)

Optional hook for parsing.

getSpecificationLookup

protected SpecificationLoader getSpecificationLookup()

getAuthenticationSessionProvider

protected AuthenticationSessionProvider getAuthenticationSessionProvider()

getAdapterMap

protected AdapterManager getAdapterMap()

getQuerySubmitter

protected QuerySubmitter getQuerySubmitter()

getAuthenticationSession

protected AuthenticationSession getAuthenticationSession()