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

Class OneToManyAssociationImpl

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

All Implemented Interfaces:

FacetHolder, IdentifiedHolder, CurrentHolder, ObjectAssociation, ObjectFeature, ObjectMember, OneToManyAssociation, OneToManyFeature, Specification

Direct Known Subclasses:

OneToManyAssociationContributee

public class OneToManyAssociationImpl
extends ObjectAssociationAbstract
implements OneToManyAssociation

Nested Class Summary

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

ObjectAssociation.Filters, ObjectAssociation.Functions, ObjectAssociation.Predicates, ObjectAssociation.Util

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

OneToManyFeature.CollectionSemantics

Field Summary

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

defaultName

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addElement(ObjectAdapter ownerAdapter, ObjectAdapter referencedAdapter) Add the specified element to this collection field in the specified object.
void	clearCollection(ObjectAdapter ownerAdapter) Remove all elements from this collection field in the specified object.
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<?>	createValidateAddInteractionContext(AuthenticationSession session, InteractionInvocationMethod invocationMethod, ObjectAdapter ownerAdapter, ObjectAdapter proposedToAddAdapter) Creates an InteractionContext that represents validation of a candidate object to be added to the collection.
ValidityContext<?>	createValidateRemoveInteractionContext(AuthenticationSession session, InteractionInvocationMethod invocationMethod, ObjectAdapter ownerAdapter, ObjectAdapter proposedToRemoveAdapter) Creates an InteractionContext that represents validation of a candidate object to be removed from the collection.
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 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()
ObjectAdapter[]	getChoices(ObjectAdapter ownerAdapter) Returns a list of possible references/values for this field, which the user can choose from.
OneToManyFeature.CollectionSemantics	getCollectionSemantics()
ObjectAdapter	getDefault(ObjectAdapter ownerAdapter) Return the default for this property.
Instance	getInstance(ObjectAdapter adapter) 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.
boolean	isEmpty(ObjectAdapter parentAdapter) Returns true if this field on the specified object is deemed to be empty, or has no content.
Consent	isValidToAdd(ObjectAdapter ownerAdapter, ObjectAdapter proposedToAddAdapter) TODO: currently this method is hard-coded to assume all interactions are initiated by user.
Consent	isValidToRemove(ObjectAdapter ownerAdapter, ObjectAdapter proposedToRemoveAdapter) TODO: currently this method is hard-coded to assume all interactions are initiated by user.
void	removeAllAssociations(ObjectAdapter ownerAdapter)
void	removeElement(ObjectAdapter ownerAdapter, ObjectAdapter referencedAdapter) Remove the specified element from this collection field in the specified object.
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

OneToManyAssociationImpl

public OneToManyAssociationImpl(FacetedMethod facetedMethod,
                        ObjectMemberContext objectMemberContext)

OneToManyAssociationImpl

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

Method Detail

getCollectionSemantics

public OneToManyFeature.CollectionSemantics getCollectionSemantics()

Specified by:

getCollectionSemantics in interface OneToManyFeature

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

createValidateAddInteractionContext

public ValidityContext<?> createValidateAddInteractionContext(AuthenticationSession session,
                                                     InteractionInvocationMethod invocationMethod,
                                                     ObjectAdapter ownerAdapter,
                                                     ObjectAdapter proposedToAddAdapter)

Description copied from interface: OneToManyAssociation

Creates an InteractionContext that represents validation of a candidate object to be added to the collection.

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

Specified by:

createValidateAddInteractionContext in interface OneToManyAssociation

isValidToAdd

public Consent isValidToAdd(ObjectAdapter ownerAdapter,
                   ObjectAdapter proposedToAddAdapter)

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

Specified by:

isValidToAdd in interface OneToManyAssociation

See Also:

#isValidToAddResult(ObjectAdapter, ObjectAdapter)

createValidateRemoveInteractionContext

public ValidityContext<?> createValidateRemoveInteractionContext(AuthenticationSession session,
                                                        InteractionInvocationMethod invocationMethod,
                                                        ObjectAdapter ownerAdapter,
                                                        ObjectAdapter proposedToRemoveAdapter)

Description copied from interface: OneToManyAssociation

Creates an InteractionContext that represents validation of a candidate object to be removed from the collection.

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

Specified by:

createValidateRemoveInteractionContext in interface OneToManyAssociation

isValidToRemove

public Consent isValidToRemove(ObjectAdapter ownerAdapter,
                      ObjectAdapter proposedToRemoveAdapter)

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

Specified by:

isValidToRemove in interface OneToManyAssociation

See Also:

OneToManyAssociation.removeElement(ObjectAdapter, ObjectAdapter), #isValidToAddResult(ObjectAdapter, ObjectAdapter)

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

isEmpty

public boolean isEmpty(ObjectAdapter parentAdapter)

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

addElement

public void addElement(ObjectAdapter ownerAdapter,
              ObjectAdapter referencedAdapter)

Description copied from interface: OneToManyAssociation

Add the specified element to this collection field in the specified object.

Specified by:

addElement in interface OneToManyAssociation

removeElement

public void removeElement(ObjectAdapter ownerAdapter,
                 ObjectAdapter referencedAdapter)

Description copied from interface: OneToManyAssociation

Remove the specified element from this collection field in the specified object.

Specified by:

removeElement in interface OneToManyAssociation

removeAllAssociations

public void removeAllAssociations(ObjectAdapter ownerAdapter)

clearCollection

public void clearCollection(ObjectAdapter ownerAdapter)

Description copied from interface: OneToManyAssociation

Remove all elements from this collection field in the specified object.

Specified by:

clearCollection in interface OneToManyAssociation

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

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

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

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 object,
                              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 adapter)

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