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

Interface ObjectAssociation

All Superinterfaces:

CurrentHolder, FacetHolder, IdentifiedHolder, ObjectFeature, ObjectMember, Specification

All Known Subinterfaces:

OneToManyAssociation, OneToOneAssociation

All Known Implementing Classes:

ObjectAssociationAbstract, OneToManyAssociationContributee, OneToManyAssociationImpl, OneToOneAssociationContributee, OneToOneAssociationImpl

public interface ObjectAssociation
extends ObjectMember, CurrentHolder

Provides reflective access to a field on a domain object.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ObjectAssociation.Filters
static class	ObjectAssociation.Functions
static class	ObjectAssociation.Predicates
static class	ObjectAssociation.Util

Method Summary

Methods

Modifier and Type	Method and Description
ObjectAdapter[]	getAutoComplete(ObjectAdapter object, String searchArg) Returns a list of possible references/values for this field, which the user can choose from, based on the provided search argument.
int	getAutoCompleteMinLength()
String	getBusinessKeyName() Get the name for the business key, if one has been specified.
ObjectAdapter[]	getChoices(ObjectAdapter object) Returns a list of possible references/values for this field, which the user can choose from.
ObjectAdapter	getDefault(ObjectAdapter adapter) Return the default for this property.
boolean	hasAutoComplete() Whether there are any auto-complete provided (eg autoCompleteXxx supporting method) for the association.
boolean	hasChoices() Whether there are any choices provided (eg choicesXxx supporting method) for the association.
boolean	isEmpty(ObjectAdapter target) Returns true if this field on the specified object is deemed to be empty, or has no content.
boolean	isMandatory() Determines if this field must be complete before the object is in a valid state
boolean	isNotPersisted() Returns true if calculated from other data in the object, that is, should not be persisted.
void	toDefault(ObjectAdapter target) Set the property to it default references/values.

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

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

get

Method Detail

getBusinessKeyName

String getBusinessKeyName()

Get the name for the business key, if one has been specified.

getDefault

ObjectAdapter getDefault(ObjectAdapter adapter)

Return the default for this property.

toDefault

void toDefault(ObjectAdapter target)

Set the property to it default references/values.

hasChoices

boolean hasChoices()

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

getChoices

ObjectAdapter[] getChoices(ObjectAdapter object)

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

hasAutoComplete

boolean hasAutoComplete()

Whether there are any auto-complete provided (eg autoCompleteXxx supporting method) for the association.

getAutoComplete

ObjectAdapter[] getAutoComplete(ObjectAdapter object,
                              String searchArg)

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

getAutoCompleteMinLength

int getAutoCompleteMinLength()

isNotPersisted

boolean isNotPersisted()

Returns true if calculated from other data in the object, that is, should not be persisted.

isEmpty

boolean isEmpty(ObjectAdapter target)

Returns true if this field on the specified object is deemed to be empty, or has no content.

isMandatory

boolean isMandatory()

Determines if this field must be complete before the object is in a valid state