Modeling.GlobalID

Package Modeling :: Module GlobalID

[show private | hide private]

Module Modeling.GlobalID

GlobalID

A GlobalID is used to Uniquely identify an object within the framework ; more precisely, speaking of an EditingContext 'ec', any object 'o' registered within 'ec' corresponds to one and only one GlobalID --see EditingContext.globalIDForObject() and EditingContext.objectForGlobalID().

Hence, it is completely equivalent to speak in terms of objects or in terms of GlobalIDs when talking relatively to a given EditingContext.

There are two type of GlobalIDs:

TemporaryGlobalID are assigned to newly created objects (see EditingContext.insertObject()), which are not yet saved within a database

KeyGlobalID identifies an object that does exist in a database store (it can be either a fully-initialized/already fetched object, or a ``fault'' object (a ``ghost'' in ZODB.Persistence jargon) that still needs to be fetched.

Both types are immutable types.

CVS information

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

Classes
`KeyGlobalID`	KeyGlobalID
`TemporaryGlobalID`	TemporaryGlobalID

Function Summary
	`globalIDWithEntityName(entityName, informations)` Returns a new GlobalID based on the supplied informations.
	`nextTemporaryIndex()` This is part of the initialization process of TemporaryGlobalID

Function Details

globalIDWithEntityName(entityName, informations=None)

Returns a new GlobalID based on the supplied informations.

Parameter 'informations' can be either:

None, in which case a TemporaryGlobalId is returned, or

an object implementing XXX,

a dictionary '{PK_name: value}', containing all entities' PKs

In the two latter cases a KeyGlobalID is returned.

nextTemporaryIndex()

This is part of the initialization process of TemporaryGlobalID

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

http://epydoc.sf.net