Back to index

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

List of all members.

Public Member Functions

def getProfileInfo
def listProfiles
def listProfileInfo
def registerProfile

Detailed Description

API for profile registry.

Definition at line 365 of file interfaces.py.


Member Function Documentation

def GenericSetup.interfaces.IProfileRegistry.getProfileInfo (   profile_id,
  for_ = None 
)
API for profile registry.
Return a mapping describing a registered filesystem profile.

o Keys include:

  'id' -- the ID of the profile

  'title' -- its title

  'description' -- a textual description of the profile

  'path' -- a path to the profile on the filesystem.

  'product' -- the name of the product to which 'path' is
     relative (None for absolute paths).

  'type' -- either BASE or EXTENSION

o 'for_', if passed, should be the interface specifying the "site
    type" for which the profile is relevant, e.g.
    Products.CMFCore.interfaces.ISiteRoot or
    Products.PluggableAuthService.interfaces.IPluggableAuthService.
    If 'None', list all profiles.

Definition at line 369 of file interfaces.py.

00369 
00370     def getProfileInfo( profile_id, for_=None ):
00371 
00372         """ Return a mapping describing a registered filesystem profile.
00373 
00374         o Keys include:
00375 
00376           'id' -- the ID of the profile
00377 
00378           'title' -- its title
00379 
00380           'description' -- a textual description of the profile
00381 
00382           'path' -- a path to the profile on the filesystem.
00383 
00384           'product' -- the name of the product to which 'path' is
00385              relative (None for absolute paths).
00386 
00387           'type' -- either BASE or EXTENSION
00388         
00389         o 'for_', if passed, should be the interface specifying the "site
00390             type" for which the profile is relevant, e.g.
00391             Products.CMFCore.interfaces.ISiteRoot or
00392             Products.PluggableAuthService.interfaces.IPluggableAuthService.
00393             If 'None', list all profiles.
00394         """

Here is the caller graph for this function:

Return a list of mappings describing registered profiles.

o See 'getProfileInfo' for a description of the mappings' keys.

o 'for_', if passed, should be the interface specifying the "site
    type" for which the profile is relevant, e.g.
    Products.CMFCore.interfaces.ISiteRoot or
    Products.PluggableAuthService.interfaces.IPluggableAuthService.
    If 'None', list all profiles.

Definition at line 406 of file interfaces.py.

00406 
00407     def listProfileInfo( for_=None ):
00408 
00409         """ Return a list of mappings describing registered profiles.
00410 
00411         o See 'getProfileInfo' for a description of the mappings' keys.
00412         
00413         o 'for_', if passed, should be the interface specifying the "site
00414             type" for which the profile is relevant, e.g.
00415             Products.CMFCore.interfaces.ISiteRoot or
00416             Products.PluggableAuthService.interfaces.IPluggableAuthService.
00417             If 'None', list all profiles.
00418         """

Here is the caller graph for this function:

Return a list of IDs for registered profiles.

o 'for_', if passed, should be the interface specifying the "site
    type" for which the profile is relevant, e.g.
    Products.CMFCore.interfaces.ISiteRoot or
    Products.PluggableAuthService.interfaces.IPluggableAuthService.
    If 'None', list all profiles.

Definition at line 395 of file interfaces.py.

00395 
00396     def listProfiles( for_=None ):
00397 
00398         """ Return a list of IDs for registered profiles.
00399         
00400         o 'for_', if passed, should be the interface specifying the "site
00401             type" for which the profile is relevant, e.g.
00402             Products.CMFCore.interfaces.ISiteRoot or
00403             Products.PluggableAuthService.interfaces.IPluggableAuthService.
00404             If 'None', list all profiles.
00405         """

Here is the caller graph for this function:

def GenericSetup.interfaces.IProfileRegistry.registerProfile (   name,
  title,
  description,
  path,
  product = None,
  profile_type = BASE,
  for_ = None 
)
Add a new profile to the registry.

o If an existing profile is already registered for 'product:name',
  raise KeyError.

o If 'product' is passed, then 'path' should be interpreted as
  relative to the corresponding product directory.

o 'for_', if passed, should be the interface specifying the "site
  type" for which the profile is relevant, e.g.
  Products.CMFCore.interfaces.ISiteRoot or
  Products.PluggableAuthService.interfaces.IPluggableAuthService.
  If 'None', the profile might be used in any site.

Definition at line 426 of file interfaces.py.

00426 
00427                        ):
00428         """ Add a new profile to the registry.
00429 
00430         o If an existing profile is already registered for 'product:name',
00431           raise KeyError.
00432 
00433         o If 'product' is passed, then 'path' should be interpreted as
00434           relative to the corresponding product directory.
00435         
00436         o 'for_', if passed, should be the interface specifying the "site
00437           type" for which the profile is relevant, e.g.
00438           Products.CMFCore.interfaces.ISiteRoot or
00439           Products.PluggableAuthService.interfaces.IPluggableAuthService.
00440           If 'None', the profile might be used in any site.
00441         """


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