org.apache.isis.core.metamodel.spec

Interface Specification

All Superinterfaces:

FacetHolder, IdentifiedHolder

All Known Subinterfaces:

ObjectAction, ObjectActionParameter, ObjectActionParameterContributee, ObjectAssociation, ObjectFeature, ObjectMember, ObjectSpecification, OneToManyAssociation, OneToManyFeature, OneToOneActionParameter, OneToOneAssociation, OneToOneFeature, ParseableEntryActionParameter, ParseableEntryFeature

All Known Implementing Classes:

ObjectActionContributee, ObjectActionImpl, ObjectActionParameterAbstract, ObjectActionParameterParseable, ObjectActionParameterParseableContributee, ObjectAssociationAbstract, ObjectMemberAbstract, ObjectSpecificationAbstract, ObjectSpecificationDefault, ObjectSpecificationForFreeStandingList, OneToManyAssociationContributee, OneToManyAssociationImpl, OneToOneActionParameterContributee, OneToOneActionParameterImpl, OneToOneAssociationContributee, OneToOneAssociationImpl

public interface Specification
extends IdentifiedHolder

Base interface for elements of the metamodel.

The most significant subinterfaces of this are ObjectSpecification and ObjectFeature (which brings in ObjectMember and ObjectActionParameter.

Introduces so that viewers can deal with abstract Instances of said.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Returns a description of how the member is used - this complements the help text.
FeatureType	getFeatureType()
Instance	getInstance(ObjectAdapter adapter) Return an Instance of this Specification with respect to the provided ObjectAdapter.

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

getFeatureType

FeatureType getFeatureType()

getDescription

String getDescription()

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

See Also:

#getHelp()

getInstance

Instance getInstance(ObjectAdapter adapter)

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.