Back to index

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

List of all members.

Public Member Functions

def register
def unregister
def setUid

Detailed Description

(Un)register unique ids on objects.

Definition at line 73 of file interfaces.py.


Member Function Documentation

(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 
)
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 

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: