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

Interface OneToOneAssociation

All Superinterfaces:

CurrentHolder, FacetHolder, IdentifiedHolder, MutableCurrentHolder, ObjectAssociation, ObjectFeature, ObjectMember, OneToOneFeature, Specification

All Known Implementing Classes:

OneToOneAssociationContributee, OneToOneAssociationImpl

public interface OneToOneAssociation
extends ObjectAssociation, OneToOneFeature, MutableCurrentHolder

Provides reflective access to a field on a domain object that is used to reference another domain object.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OneToOneAssociation.Functions

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

ObjectAssociation.Filters, ObjectAssociation.Predicates, ObjectAssociation.Util

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAssociation(ObjectAdapter inObject) Deprecated. - see MutableCurrentHolder.set(ObjectAdapter, ObjectAdapter)
PropertyAccessContext	createAccessInteractionContext(AuthenticationSession session, InteractionInvocationMethod interactionMethod, ObjectAdapter targetObjectAdapter) Creates an InteractionContext that represents access to this property.
ValidityContext<?>	createValidateInteractionContext(AuthenticationSession session, InteractionInvocationMethod interactionMethod, ObjectAdapter targetObjectAdapter, ObjectAdapter proposedValue) Creates an InteractionContext that represents validation of a proposed new value for the property.
void	initAssociation(ObjectAdapter inObject, ObjectAdapter associate) Initialise this field in the specified object with the specified reference - this call should only affect the specified object, and not any related objects.
Consent	isAssociationValid(ObjectAdapter inObject, ObjectAdapter associate) Determines if the specified reference is valid for setting this field in the specified object, represented as a Consent.
void	setAssociation(ObjectAdapter inObject, ObjectAdapter associate) Deprecated. - see MutableCurrentHolder.set(ObjectAdapter, ObjectAdapter)

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

getAutoComplete, getAutoCompleteMinLength, getBusinessKeyName, getChoices, getDefault, hasAutoComplete, hasChoices, isEmpty, isMandatory, isNotPersisted, toDefault

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

set

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

get

Method Detail

initAssociation

void initAssociation(ObjectAdapter inObject,
                   ObjectAdapter associate)

Initialise this field in the specified object with the specified reference - this call should only affect the specified object, and not any related objects. It should also not be distributed. This is strictly for re-initialising the object and not specifying an association, which is only done once.

createAccessInteractionContext

PropertyAccessContext createAccessInteractionContext(AuthenticationSession session,
                                                   InteractionInvocationMethod interactionMethod,
                                                   ObjectAdapter targetObjectAdapter)

Creates an InteractionContext that represents access to this property.

createValidateInteractionContext

ValidityContext<?> createValidateInteractionContext(AuthenticationSession session,
                                                  InteractionInvocationMethod interactionMethod,
                                                  ObjectAdapter targetObjectAdapter,
                                                  ObjectAdapter proposedValue)

Creates an InteractionContext that represents validation of a proposed new value for the property.

Typically it is easier to just call isAssociationValid(ObjectAdapter, ObjectAdapter) or #isAssociationValidResult(ObjectAdapter, ObjectAdapter); this is provided as API for symmetry with interactions (such as AccessContext accesses) have no corresponding vetoing methods.

isAssociationValid

Consent isAssociationValid(ObjectAdapter inObject,
                         ObjectAdapter associate)

Determines if the specified reference is valid for setting this field in the specified object, represented as a Consent.

setAssociation

@Deprecated
void setAssociation(ObjectAdapter inObject,
                             ObjectAdapter associate)

Deprecated. - see MutableCurrentHolder.set(ObjectAdapter, ObjectAdapter)

Set up the association represented by this field in the specified object with the specified reference - this call sets up the logical state of the object and might affect other objects that share this association (such as back-links or bidirectional association). To initialise a recreated object to this logical state the initAssociation method should be used on each of the objects.

See Also:

initAssociation(ObjectAdapter, ObjectAdapter)

clearAssociation

@Deprecated
void clearAssociation(ObjectAdapter inObject)

Deprecated. - see MutableCurrentHolder.set(ObjectAdapter, ObjectAdapter)

Clear this reference field (make it null) in the specified object, and remove any association back-link.

See Also:

setAssociation(ObjectAdapter, ObjectAdapter)