Modeling.interfaces.ClassDescription.ClassDescriptionInterface

Package Modeling :: Package interfaces :: Module ClassDescription :: Class ClassDescriptionInterface

[show private | hide private]

Class ClassDescriptionInterface

Base --+
       |
      ClassDescriptionInterface

Documentation forthcoming

Implemented by:

EntityClassDescription

CMFClassDescription (still TBD)

Method Summary
	`adaptorName(self)` Returns the name of the adaptor used to make persistent the corresponding instances
	`attributesKeys(self)`
	`classDescriptionForDestinationKey(self, destinationKey)` Returns the class description registered for the destination entity of relationship named 'aKey'
	`createInstanceWithEditingContext(self, editingContext)` Implemented by subclasses to return a new object of the appropriate class.
	`delegate(self)` Returns the object's delegate
	`deleteRuleForRelationshipKey(self, aKey)`
	`displayNameForKey(self, aKey)`
	`entityName(self)`
	`foreignKeys(self)` Returns the names of foreign keys for the object, i.e.
	`inverseForRelationshipKey(self, aKey)`
	`primaryKeys(self)` Returns the names of primary keys for the object
	`propagateDeleteForObject(self, anObject, editingContext)`
	`propagateInsertionForObject(self, anObject, editingContext)` Examines the object's relationships and searches for related objects not inserted in 'editingContext', then inserts these objects into editingContextif they are not already registered.
	`registeredBy(self, aClassDescriptionProvider)` Sets the class_description_provider in which the receiver is registered.
	`setDelegate(self, aDelegate)` Sets the object's delegate
	`toManyRelationshipKeys(self)` Returns the to-many relationships keys, as tuple
	`toOneRelationshipKeys(self)` Returns the to-one relationships keys, as tuple
	`userPresentableDescriptionForObject(self, anObject)` Returns a
	`validateObjectForDelete(self, anObject)`
	`validateObjectForSave(self, anObject)`
	`validateValueForKey(self, object, aValue, aKey)` attribute/relationship validateValue + attribute: search and exec.
	`XMLDescriptionForObject(self, anObject)` Returns an DOM representing the object

Method Details

adaptorName(self)

Returns the name of the adaptor used to make persistent the corresponding instances

classDescriptionForDestinationKey(self, destinationKey)

Returns the class description registered for the destination entity of relationship named 'aKey'

createInstanceWithEditingContext(self, editingContext)

Implemented by subclasses to return a new object of the appropriate class. For example, 'EntityClassDescription' subclass uses an Entity to determine the class from which the instance should be instanciated.

delegate(self)

Returns the object's delegate

See also: interfaces.ClassDescriptionDelegate

foreignKeys(self)

Returns the names of foreign keys for the object, i.e. the source attributes' names of to-one relationships.

See also: toOneRelationshipKeys(), allToOneRelationshipKeys()

primaryKeys(self)

Returns the names of primary keys for the object

propagateInsertionForObject(self, anObject, editingContext)

Examines the object's relationships and searches for related objects not inserted in 'editingContext', then inserts these objects into editingContextif they are not already registered.

This is normally called when an EditingContext gets the processRecentChanges() message.

See also: EditingContext.propagatesInsertionForRelatedObjects()

registeredBy(self, aClassDescriptionProvider)

Sets the class_description_provider in which the receiver is registered.

Note that this is needed by implementation, not by design: since we still do not have any EventManager, the only way method classDescriptionForDestinationKey() can make it is to ask its provider, so we need it. Hence is it very important that the provider notifies the class description that it holds it.

setDelegate(self, aDelegate)

Sets the object's delegate

See also: interfaces.ClassDescriptionDelegate

toManyRelationshipKeys(self)

Returns the to-many relationships keys, as tuple

toOneRelationshipKeys(self)

Returns the to-one relationships keys, as tuple

userPresentableDescriptionForObject(self, anObject)

Returns a

validateValueForKey(self, object, aValue, aKey)

attribute/relationship validateValue + attribute: search and exec. validate<AttributeName> method

XMLDescriptionForObject(self, anObject)

Returns an DOM representing the object

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

http://epydoc.sf.net