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

Class OneToOneAssociationImpl

java.lang.Object

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

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

OneToOneAssociationContributee

public class OneToOneAssociationImpl
extends ObjectAssociationAbstract
implements OneToOneAssociation

Nested Class Summary

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

OneToOneAssociation.Functions

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

ObjectAssociation.Filters, ObjectAssociation.Predicates, ObjectAssociation.Util

Field Summary

Fields inherited from class org.apache.isis.core.metamodel.specloader.specimpl.ObjectMemberAbstract

defaultName

Constructor Summary

Constructors

Modifier	Constructor and Description
	OneToOneAssociationImpl(FacetedMethod facetedMethod, ObjectMemberContext objectMemberContext)
protected	OneToOneAssociationImpl(FacetedMethod facetedMethod, ObjectSpecification objectSpec, ObjectMemberContext objectMemberContext)

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAssociation(ObjectAdapter ownerAdapter) Deprecated.
PropertyAccessContext	createAccessInteractionContext(AuthenticationSession session, InteractionInvocationMethod interactionMethod, ObjectAdapter ownerAdapter) TODO: currently this method is hard-coded to assume all interactions are initiated by user.
UsabilityContext<?>	createUsableInteractionContext(AuthenticationSession session, InteractionInvocationMethod invocationMethod, ObjectAdapter ownerAdapter, org.apache.isis.applib.annotation.Where where) Create an InteractionContext to represent an attempt to use this member (that is, to check if it is usable or not).
ValidityContext<?>	createValidateInteractionContext(AuthenticationSession session, InteractionInvocationMethod interactionMethod, ObjectAdapter ownerAdapter, ObjectAdapter proposedToReferenceAdapter) Creates an InteractionContext that represents validation of a proposed new value for the property.
VisibilityContext<?>	createVisibleInteractionContext(AuthenticationSession session, InteractionInvocationMethod invocationMethod, ObjectAdapter ownerAdapter, org.apache.isis.applib.annotation.Where where) Create an InteractionContext to represent an attempt to view this member (that is, to check if it is visible or not).
String	debugData()
ObjectAdapter	get(ObjectAdapter ownerAdapter) Returns the referenced ObjectAdapter for the owning ObjectAdapter.
ObjectAdapter[]	getAutoComplete(ObjectAdapter ownerAdapter, 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()
ObjectAdapter[]	getChoices(ObjectAdapter ownerAdapter) Returns a list of possible references/values for this field, which the user can choose from.
ObjectAdapter	getDefault(ObjectAdapter ownerAdapter) Return the default for this property.
Instance	getInstance(ObjectAdapter ownerAdapter) Return an Instance of this Specification with respect to the provided ObjectAdapter.
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.
void	initAssociation(ObjectAdapter ownerAdapter, ObjectAdapter referencedAdapter) 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 ownerAdapter, ObjectAdapter proposedToReferenceAdapter) TODO: currently this method is hard-coded to assume all interactions are initiated by user.
boolean	isEmpty(ObjectAdapter ownerAdapter) Returns true if this field on the specified object is deemed to be empty, or has no content.
void	set(ObjectAdapter ownerAdapter, ObjectAdapter newReferencedAdapter) Updates the referenced ObjectAdapter for the owning ObjectAdapter with the new value provided, or clears the reference if null.
void	setAssociation(ObjectAdapter ownerAdapter, ObjectAdapter newReferencedAdapter) Deprecated.
void	toDefault(ObjectAdapter ownerAdapter) Set the property to it default references/values.
String	toString()

Methods inherited from class org.apache.isis.core.metamodel.specloader.specimpl.ObjectAssociationAbstract

getBusinessKeyName, getSpecification, isMandatory, isNotPersisted, isOneToOneAssociation

Methods inherited from class org.apache.isis.core.metamodel.specloader.specimpl.ObjectMemberAbstract

addFacet, addFacet, containsDoOpFacet, containsFacet, getAdapterManager, getAuthenticationSession, getAuthenticationSessionProvider, getCollectionTypeRegistry, getDeploymentCategory, getDescription, getFacet, getFacetedMethod, getFacets, getFacetTypes, getFeatureType, getHelp, getId, getIdentifier, getName, getQuerySubmitter, getServicesProvider, getSpecification, getSpecificationLookup, isAction, isAlwaysHidden, isOneToManyAssociation, isPropertyOrCollection, isUsable, isVisible, removeFacet, removeFacet

Methods inherited from class java.lang.Object

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

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

getBusinessKeyName, isMandatory, isNotPersisted

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

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

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

Constructor Detail

OneToOneAssociationImpl

public OneToOneAssociationImpl(FacetedMethod facetedMethod,
                       ObjectMemberContext objectMemberContext)

OneToOneAssociationImpl

protected OneToOneAssociationImpl(FacetedMethod facetedMethod,
                       ObjectSpecification objectSpec,
                       ObjectMemberContext objectMemberContext)

Method Detail

createVisibleInteractionContext

public VisibilityContext<?> createVisibleInteractionContext(AuthenticationSession session,
                                                   InteractionInvocationMethod invocationMethod,
                                                   ObjectAdapter ownerAdapter,
                                                   org.apache.isis.applib.annotation.Where where)

Description copied from interface: ObjectMember

Create an InteractionContext to represent an attempt to view this member (that is, to check if it is visible or not).

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

Specified by:

createVisibleInteractionContext in interface ObjectMember

createUsableInteractionContext

public UsabilityContext<?> createUsableInteractionContext(AuthenticationSession session,
                                                 InteractionInvocationMethod invocationMethod,
                                                 ObjectAdapter ownerAdapter,
                                                 org.apache.isis.applib.annotation.Where where)

Description copied from interface: ObjectMember

Create an InteractionContext to represent an attempt to use this member (that is, to check if it is usable or not).

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

Specified by:

createUsableInteractionContext in interface ObjectMember

createValidateInteractionContext

public ValidityContext<?> createValidateInteractionContext(AuthenticationSession session,
                                                  InteractionInvocationMethod interactionMethod,
                                                  ObjectAdapter ownerAdapter,
                                                  ObjectAdapter proposedToReferenceAdapter)

Description copied from interface: OneToOneAssociation

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

Typically it is easier to just call OneToOneAssociation.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.

Specified by:

createValidateInteractionContext in interface OneToOneAssociation

isAssociationValid

public Consent isAssociationValid(ObjectAdapter ownerAdapter,
                         ObjectAdapter proposedToReferenceAdapter)

TODO: currently this method is hard-coded to assume all interactions are initiated by user.

Specified by:

isAssociationValid in interface OneToOneAssociation

initAssociation

public void initAssociation(ObjectAdapter ownerAdapter,
                   ObjectAdapter referencedAdapter)

Description copied from interface: OneToOneAssociation

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.

Specified by:

initAssociation in interface OneToOneAssociation

get

public ObjectAdapter get(ObjectAdapter ownerAdapter)

Description copied from interface: CurrentHolder

Returns the referenced ObjectAdapter for the owning ObjectAdapter.

For example, if this is an OneToOneAssociation, then returns the referenced object.

Specified by:

get in interface CurrentHolder

Specified by:

get in class ObjectAssociationAbstract

createAccessInteractionContext

public PropertyAccessContext createAccessInteractionContext(AuthenticationSession session,
                                                   InteractionInvocationMethod interactionMethod,
                                                   ObjectAdapter ownerAdapter)

TODO: currently this method is hard-coded to assume all interactions are initiated by user.

Specified by:

createAccessInteractionContext in interface OneToOneAssociation

isEmpty

public boolean isEmpty(ObjectAdapter ownerAdapter)

Description copied from interface: ObjectAssociation

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

Specified by:

isEmpty in interface ObjectAssociation

Specified by:

isEmpty in class ObjectAssociationAbstract

set

public void set(ObjectAdapter ownerAdapter,
       ObjectAdapter newReferencedAdapter)

Description copied from interface: MutableCurrentHolder

Updates the referenced ObjectAdapter for the owning ObjectAdapter with the new value provided, or clears the reference if null.

For example, if this is a OneToOneAssociation, then updates the object referenced .

Specified by:

set in interface MutableCurrentHolder

newReferencedAdapter - - the new value, or null

setAssociation

@Deprecated
public void setAssociation(ObjectAdapter ownerAdapter,
                             ObjectAdapter newReferencedAdapter)

Deprecated.

Description copied from interface: OneToOneAssociation

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.

Specified by:

setAssociation in interface OneToOneAssociation

See Also:

set(ObjectAdapter, ObjectAdapter)

clearAssociation

@Deprecated
public void clearAssociation(ObjectAdapter ownerAdapter)

Deprecated.

Description copied from interface: OneToOneAssociation

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

Specified by:

clearAssociation in interface OneToOneAssociation

See Also:

set(ObjectAdapter, ObjectAdapter)

getDefault

public ObjectAdapter getDefault(ObjectAdapter ownerAdapter)

Description copied from interface: ObjectAssociation

Return the default for this property.

Specified by:

getDefault in interface ObjectAssociation

toDefault

public void toDefault(ObjectAdapter ownerAdapter)

Description copied from interface: ObjectAssociation

Set the property to it default references/values.

Specified by:

toDefault in interface ObjectAssociation

hasChoices

public boolean hasChoices()

Description copied from interface: ObjectAssociation

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

Specified by:

hasChoices in interface ObjectAssociation

Overrides:

hasChoices in class ObjectAssociationAbstract

getChoices

public ObjectAdapter[] getChoices(ObjectAdapter ownerAdapter)

Description copied from interface: ObjectAssociation

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

Specified by:

getChoices in interface ObjectAssociation

hasAutoComplete

public boolean hasAutoComplete()

Description copied from interface: ObjectAssociation

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

Specified by:

hasAutoComplete in interface ObjectAssociation

getAutoComplete

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

Description copied from interface: ObjectAssociation

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

Specified by:

getAutoComplete in interface ObjectAssociation

getAutoCompleteMinLength

public int getAutoCompleteMinLength()

Specified by:

getAutoCompleteMinLength in interface ObjectAssociation

getInstance

public Instance getInstance(ObjectAdapter ownerAdapter)

Description copied from interface: Specification

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.

Specified by:

getInstance in interface Specification

debugData

public String debugData()

Specified by:

debugData in interface ObjectMember

toString

public String toString()

Overrides:

toString in class ObjectMemberAbstract