Back to index

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

List of all members.

Public Member Functions

def register
def unregister
def setUid
def queryUid
def getUid
def queryObject
def getObject

Detailed Description

Handle registering, querying unique ids and objects.

Definition at line 132 of file interfaces.py.


Member Function Documentation

def CMFUid.interfaces.IUniqueIdQuery.getObject (   uid) [inherited]
Return the object with the given uid.

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

Definition at line 124 of file interfaces.py.

00124 
00125     def getObject(uid):
00126         """Return the object with the given uid.
00127 
00128         If no object exist with the given unique id, a UniqueIdError is raised.
00129         """
00130 
00131 
# This is the main API for playing with unique ids

Here is the caller graph for this function:

def CMFUid.interfaces.IUniqueIdQuery.getUid (   obj) [inherited]
Return the unique id of the object.

If the object doesn't have a unique, a UniqueIdError is raised.

Definition at line 111 of file interfaces.py.

00111 
00112     def getUid(obj):
00113         """Return the unique id of the object.
00114 
00115         If the object doesn't have a unique, a UniqueIdError is raised.
00116         """

def CMFUid.interfaces.IUniqueIdQuery.queryObject (   uid,
  default = None 
) [inherited]
Return the object with the given uid.

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

Definition at line 117 of file interfaces.py.

00117 
00118     def queryObject(uid, default=None):
00119         """Return the object with the given uid.
00120 
00121         If no object exist with the given unique id, the default value is
00122         returned.
00123         """

Here is the caller graph for this function:

def CMFUid.interfaces.IUniqueIdQuery.queryUid (   obj,
  default = None 
) [inherited]
Querying unique ids.
Return the unique id of the object.

If the object doesn't have a unique, the default value is returned.

Definition at line 105 of file interfaces.py.

00105 
00106     def queryUid(obj, default=None):
00107         """Return the unique id of the object.
00108 
00109         If the object doesn't have a unique, the default value is returned.
00110         """

Here is the caller graph for this function:

def CMFUid.interfaces.IUniqueIdSet.register (   obj) [inherited]
(Un)register unique ids on objects.
Register the object and return the unique id generated for it.

If the object is already registered, its unique id is returned anyway.

UniqueIdError is raised if object can not be registered a unique id.

Definition at line 78 of file interfaces.py.

00078 
00079     def register(obj):
00080         """Register the object and return the unique id generated for it.
00081 
00082         If the object is already registered, its unique id is returned anyway.
00083 
00084         UniqueIdError is raised if object can not be registered a unique id.
00085         """

Here is the caller graph for this function:

def CMFUid.interfaces.IUniqueIdSet.setUid (   obj,
  uid,
  check_uniqueness = True 
) [inherited]
Set the unique id of an object.

By default a check ensuring uniqueness is enabled. Be aware when
disabling this check: You really need to know what you do !!!

Definition at line 92 of file interfaces.py.

00092 
00093     def setUid(obj, uid, check_uniqueness=True):
00094         """Set the unique id of an object.
00095 
00096         By default a check ensuring uniqueness is enabled. Be aware when
00097         disabling this check: You really need to know what you do !!!
00098         """
00099 

def CMFUid.interfaces.IUniqueIdSet.unregister (   obj) [inherited]
Remove the object from the indexes.

UniqueIdError is raised if object was not registered previously.

Definition at line 86 of file interfaces.py.

00086 
00087     def unregister(obj):
00088         """Remove the object from the indexes.
00089 
00090         UniqueIdError is raised if object was not registered previously.
00091         """

Here is the caller graph for this function:


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