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

Interface ObjectFeature

All Superinterfaces:

FacetHolder, IdentifiedHolder, Specification

All Known Subinterfaces:

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

All Known Implementing Classes:

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

public interface ObjectFeature
extends Specification

A specification representing a non-object, that therefore has an underlying type (the type of the property, collection)

For a property or action parameter, is the type. For a collection is the element type. For an action it is always null.

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.
String	getId() Returns the identifier of the member, which must not change.
String	getName() Return the name for this member - the field or action.
ObjectSpecification	getSpecification() The specification of the underlying type.

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

getId

String getId()

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

getName

String getName()

Return the name for this member - the field or action. This is based on the name of this member.

See Also:

IdentifiedHolder.getIdentifier()

getDescription

String getDescription()

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

Specified by:

getDescription in interface Specification

See Also:

#getHelp()

getSpecification

ObjectSpecification getSpecification()

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