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

Interface OneToManyAssociation

All Superinterfaces:

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

All Known Implementing Classes:

OneToManyAssociationContributee, OneToManyAssociationImpl

public interface OneToManyAssociation
extends ObjectAssociation, OneToManyFeature

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addElement(ObjectAdapter owningObjectAdapter, ObjectAdapter objectToAdd) Add the specified element to this collection field in the specified object.
void	clearCollection(ObjectAdapter inObject) Remove all elements from this collection field in the specified object.
ValidityContext<?>	createValidateAddInteractionContext(AuthenticationSession session, InteractionInvocationMethod invocationMethod, ObjectAdapter owningObjectAdapter, ObjectAdapter proposedObjectToAdd) Creates an InteractionContext that represents validation of a candidate object to be added to the collection.
ValidityContext<?>	createValidateRemoveInteractionContext(AuthenticationSession session, InteractionInvocationMethod invocationMethod, ObjectAdapter owningObjectAdapter, ObjectAdapter proposedObjectToRemove) Creates an InteractionContext that represents validation of a candidate object to be removed from the collection.
Consent	isValidToAdd(ObjectAdapter owningObjectAdapter, ObjectAdapter proposedObjectToAdd) Determines if the specified element can be added to the collection field, represented as a Consent.
Consent	isValidToRemove(ObjectAdapter owningObjectAdapter, ObjectAdapter proposedObjectToRemove) Determines if the specified element can be removed from the collection field, represented as a Consent.
void	removeElement(ObjectAdapter owningObjectAdapter, ObjectAdapter oObjectToRemove) Remove the specified element from this collection field in the specified object.

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

get

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

getCollectionSemantics

Method Detail

createValidateAddInteractionContext

ValidityContext<?> createValidateAddInteractionContext(AuthenticationSession session,
                                                     InteractionInvocationMethod invocationMethod,
                                                     ObjectAdapter owningObjectAdapter,
                                                     ObjectAdapter proposedObjectToAdd)

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

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

isValidToAdd

Consent isValidToAdd(ObjectAdapter owningObjectAdapter,
                   ObjectAdapter proposedObjectToAdd)

Determines if the specified element can be added to the collection field, represented as a Consent.

If allowed the add method can be called with the same parameters, .

See Also:

#isValidToAddResult(ObjectAdapter, ObjectAdapter)

addElement

void addElement(ObjectAdapter owningObjectAdapter,
              ObjectAdapter objectToAdd)

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

createValidateRemoveInteractionContext

ValidityContext<?> createValidateRemoveInteractionContext(AuthenticationSession session,
                                                        InteractionInvocationMethod invocationMethod,
                                                        ObjectAdapter owningObjectAdapter,
                                                        ObjectAdapter proposedObjectToRemove)

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

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

isValidToRemove

Consent isValidToRemove(ObjectAdapter owningObjectAdapter,
                      ObjectAdapter proposedObjectToRemove)

Determines if the specified element can be removed from the collection field, represented as a Consent.

If allowed the remove method can be called with the same parameters, .

See Also:

removeElement(ObjectAdapter, ObjectAdapter), #isValidToAddResult(ObjectAdapter, ObjectAdapter)

removeElement

void removeElement(ObjectAdapter owningObjectAdapter,
                 ObjectAdapter oObjectToRemove)

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

clearCollection

void clearCollection(ObjectAdapter inObject)

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