Modeling.RelationshipManipulation

Package Modeling :: Module RelationshipManipulation

[show private | hide private]

Module Modeling.RelationshipManipulation

Allows the generic manipulation of objects in relation by inspecting the underlying model and taking appropriate actions.

This modules consists of two parts:

module functions implementing the default behaviour for the API

a mix-in class using this default implementation

See interfaces.RelationshipManipulating for a full description of the default implementation.

CVS information

$Id: RelationshipManipulation.py,v 1.6 2004/07/20 06:21:37 sbigaret Exp $

Classes
`RelationshipManipulation`	This mix-in class provides the default implementation for RelationshipManipulation interface to all subclasses.

Function Summary
	`addObjectToBothSidesOfRelationshipWithKey(self, anObject, aKey)` See interfaces.RelationshipManipulating
	`addObjectToPropertyWithKey(self, anObject, aKey)` See interfaces.RelationshipManipulating
	`removeObjectFromBothSidesOfRelationshipWithKey(self, anObject, aKey)` See interfaces.RelationshipManipulating
	`removeObjectFromPropertyWithKey(self, anObject, aKey)` See interfaces.RelationshipManipulating
	`_addObjectToPropertyWithKey(self, anObject, aKey, toOnes, toManys)` Private method used by the methods in this module to avoid the re-computation of to-one and to-many relationships when it is not necessary.
	`_removeObjectFromBothSidesOfRelationshipWithKey(self, anObject, aKey, toOnes, toManys)` Private method used by the methods in this module to avoid the re-computation of to-one and to-many relationships when it is not necessary.
	`_removeObjectFromPropertyWithKey(self, anObject, aKey, toOnes, toManys)` Private method used by the methods in this module to avoid the re-computation of to-one and to-many relationships when it is not necessary.

Function Details

addObjectToBothSidesOfRelationshipWithKey(self, anObject, aKey)

See interfaces.RelationshipManipulating

addObjectToPropertyWithKey(self, anObject, aKey)

See interfaces.RelationshipManipulating

removeObjectFromBothSidesOfRelationshipWithKey(self, anObject, aKey)

See interfaces.RelationshipManipulating

removeObjectFromPropertyWithKey(self, anObject, aKey)

See interfaces.RelationshipManipulating

_addObjectToPropertyWithKey(self, anObject, aKey, toOnes, toManys)

Private method used by the methods in this module to avoid the re-computation of to-one and to-many relationships when it is not necessary.

Parameters are the same as for addObjectToPropertyWithKey, with the additional parameters:

toOnes -- should equal to

self.classDescription().toOneRelationshipKeys()

toManys -- should equal to

self.classDescription().toManyRelationshipKeys()

_removeObjectFromBothSidesOfRelationshipWithKey(self, anObject, aKey, toOnes, toManys)

Private method used by the methods in this module to avoid the re-computation of to-one and to-many relationships when it is not necessary.

Parameters are the same as for removeObjectFromBothSidesOfRelationshipWithKey, with the additional parameters:

toOnes -- should equal to self.classDescription().toOneRelationshipKeys()

toManys -- should equal to

self.classDescription().toManyRelationshipKeys()

_removeObjectFromPropertyWithKey(self, anObject, aKey, toOnes, toManys)

Private method used by the methods in this module to avoid the re-computation of to-one and to-many relationships when it is not necessary.

Parameters are the same as for removeObjectFromPropertyWithKey(), with the additional parameters:

toOnes -- should equal to self.classDescription().toOneRelationshipKeys()

toManys -- should equal to

self.classDescription().toManyRelationshipKeys()

Generated by Epydoc 2.1 on Sat Mar 4 13:36:22 2006

http://epydoc.sf.net