Back to index

plone3  3.1.7
Public Member Functions
CMFUid.interfaces.IUniqueIdBrainQuery Class Reference
Inheritance diagram for CMFUid.interfaces.IUniqueIdBrainQuery:
Inheritance graph
[legend]
Collaboration diagram for CMFUid.interfaces.IUniqueIdBrainQuery:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def queryBrain
def getBrain

Detailed Description

Querying unique ids returning brains for efficiency sake.

Returning a brain is more efficient than returning the object. A brain
usually exposes only parts of the object and should only be read from.

If the implementing class doesn't support returning a catalog brain it may
fallback to return the object. To be entirely compatible it must implement
the (non existing) interface catalog brains implement.

Definition at line 139 of file interfaces.py.


Member Function Documentation

Return a brain of the object with the given uid.

If no object exist with the given unique id, a UniqueIdError is
raised.

Definition at line 158 of file interfaces.py.

00158 
00159     def getBrain(uid):
00160         """Return a brain of the object with the given uid.
00161 
00162         If no object exist with the given unique id, a UniqueIdError is
00163         raised.
00164         """
00165 
00166 
# This is another secondary API enhancement

Here is the caller graph for this function:

def CMFUid.interfaces.IUniqueIdBrainQuery.queryBrain (   uid,
  default = None 
)
Querying unique ids returning brains for efficiency sake.

Returning a brain is more efficient than returning the object. A brain
usually exposes only parts of the object and should only be read from.

If the implementing class doesn't support returning a catalog brain it may
fallback to return the object. To be entirely compatible it must implement
the (non existing) interface catalog brains implement.
Return the brain of object with the given uid.

If no object exist with the given unique id, the default value
is returned.

Definition at line 151 of file interfaces.py.

00151 
00152     def queryBrain(uid, default=None):
00153         """Return the brain of object with the given uid.
00154 
00155         If no object exist with the given unique id, the default value
00156         is returned.
00157         """

Here is the caller graph for this function:


The documentation for this class was generated from the following file: