Back to index

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

List of all members.

Public Member Functions

def listForbiddenTools
def addForbiddenTool
def listRequiredTools
def getRequiredToolInfo
def listRequiredToolInfo
def addRequiredTool

Detailed Description

API for toolset registry.

Definition at line 311 of file interfaces.py.


Member Function Documentation

Add 'tool_id' to the list of forbidden tools.

o Raise KeyError if 'tool_id' is already in the list.

o Raise ValueError if 'tool_id' is in the "required" list.

Definition at line 320 of file interfaces.py.

00320 
00321     def addForbiddenTool(tool_id ):
00322 
00323         """ Add 'tool_id' to the list of forbidden tools.
00324 
00325         o Raise KeyError if 'tool_id' is already in the list.
00326 
00327         o Raise ValueError if 'tool_id' is in the "required" list.
00328         """

Here is the caller graph for this function:

def GenericSetup.interfaces.IToolsetRegistry.addRequiredTool (   tool_id,
  dotted_name 
)
Add a tool to our "required" list.

o 'tool_id' is the tool's ID.

o 'dotted_name' is a dotted (importable) name of the tool's class.

o Raise KeyError if we have already registered a class for 'tool_id'.

o Raise ValueError if 'tool_id' is in the "forbidden" list.

Definition at line 352 of file interfaces.py.

00352 
00353     def addRequiredTool( tool_id, dotted_name ):
00354 
00355         """ Add a tool to our "required" list.
00356 
00357         o 'tool_id' is the tool's ID.
00358 
00359         o 'dotted_name' is a dotted (importable) name of the tool's class.
00360 
00361         o Raise KeyError if we have already registered a class for 'tool_id'.
00362 
00363         o Raise ValueError if 'tool_id' is in the "forbidden" list.
00364         """

Here is the caller graph for this function:

Return a mapping describing a partiuclar required tool.

o Keys include:

  'id' -- the ID of the tool

  'class' -- a dotted path to its class

o Raise KeyError if 'tool_id' id not a known tool.

Definition at line 334 of file interfaces.py.

00334 
00335     def getRequiredToolInfo( tool_id ):
00336 
00337         """ Return a mapping describing a partiuclar required tool.
00338 
00339         o Keys include:
00340 
00341           'id' -- the ID of the tool
00342 
00343           'class' -- a dotted path to its class
00344 
00345         o Raise KeyError if 'tool_id' id not a known tool.
00346         """

Here is the caller graph for this function:

API for toolset registry.
Return a list of IDs of tools which must be removed, if present.

Definition at line 315 of file interfaces.py.

00315 
00316     def listForbiddenTools():
00317 
00318         """ Return a list of IDs of tools which must be removed, if present.
00319         """

Return a list of IDs of tools which must be present.

Definition at line 347 of file interfaces.py.

00347 
00348     def listRequiredToolInfo():
00349 
00350         """ Return a list of IDs of tools which must be present.
00351         """

Return a list of IDs of tools which must be present.

Definition at line 329 of file interfaces.py.

00329 
00330     def listRequiredTools():
00331 
00332         """ Return a list of IDs of tools which must be present.
00333         """

Here is the caller graph for this function:


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