Back to index

plone3  3.1.7
Public Member Functions
CMFCore.interfaces._tools.ITypeInformation Class Reference
Inheritance diagram for CMFCore.interfaces._tools.ITypeInformation:
Inheritance graph
[legend]
Collaboration diagram for CMFCore.interfaces._tools.ITypeInformation:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def Metatype
def Title
def Description
def isConstructionAllowed
def allowType
def constructInstance
def allowDiscussion
def getIcon
def getMethodAliases
def setMethodAliases
def queryMethodID

Detailed Description

Type definition interface.

Definition at line 1331 of file _tools.py.


Member Function Documentation

Return True if objects of this type are allowed to support
    discussion, else False.

o Individual objects may still disable discussion.

Definition at line 1374 of file _tools.py.

01374 
01375     def allowDiscussion():
01376         """ Return True if objects of this type are allowed to support
01377             discussion, else False.
01378 
01379         o Individual objects may still disable discussion.
01380         """

Can objects of 'contentType' be added to containers of our type?

Definition at line 1362 of file _tools.py.

01362 
01363     def allowType(contentType):
01364         """ Can objects of 'contentType' be added to containers of our type?
01365         """

Build a "bare" instance of the appropriate type in 'container'.

o Give the new instance an ID of 'id'.

o Return the newly-created instance, seated in 'container'.

Definition at line 1366 of file _tools.py.

01366 
01367     def constructInstance(container, id):
01368         """ Build a "bare" instance of the appropriate type in 'container'.
01369 
01370         o Give the new instance an ID of 'id'.
01371 
01372         o Return the newly-created instance, seated in 'container'.
01373         """

Return a textual description of the type

o This descriptoin is used for display in a "constructor list".

Definition at line 1351 of file _tools.py.

01351 
01352     def Description():
01353         """ Return a textual description of the type
01354 
01355         o This descriptoin is used for display in a "constructor list".
01356         """

Here is the caller graph for this function:

Return the portal-relative URL for the icon for this type.

Definition at line 1381 of file _tools.py.

01381 
01382     def getIcon():
01383         """ Return the portal-relative URL for the icon for this type.
01384         """

Here is the caller graph for this function:

Return a mapping of method aliases for this type.

o XXX:  define keys and values of the mapping.

o Permission:  Manage portal

Definition at line 1385 of file _tools.py.

01385 
01386     def getMethodAliases():
01387         """ Return a mapping of method aliases for this type.
01388 
01389         o XXX:  define keys and values of the mapping.
01390 
01391         o Permission:  Manage portal
01392         """

Return True if the current user is allowed to construct an
    instance of this type in 'container, else False.

Definition at line 1357 of file _tools.py.

01357 
01358     def isConstructionAllowed(container):
01359         """ Return True if the current user is allowed to construct an
01360             instance of this type in 'container, else False.
01361         """

Here is the caller graph for this function:

Type definition interface.
Return the Zope 'meta_type' for this content object.

o Deprecated (not all objects of a given type may even share
  the same meta_type).

Definition at line 1336 of file _tools.py.

01336 
01337     def Metatype():
01338         """ Return the Zope 'meta_type' for this content object.
01339 
01340         o Deprecated (not all objects of a given type may even share
01341           the same meta_type).
01342         """

def CMFCore.interfaces._tools.ITypeInformation.queryMethodID (   alias,
  default = None,
  context = None 
)
Return the method ID for a given alias.

o 'context', if passed, points to the object calling this method.
   It may be used to return dynamic values based on the caller.
   XXX:  this is unclear

o 'default' is returned if no such alias is defined.

o Permission:  Public

Returns:  Method ID or default value

Definition at line 1405 of file _tools.py.

01405 
01406     def queryMethodID(alias, default=None, context=None):
01407         """ Return the method ID for a given alias.
01408 
01409         o 'context', if passed, points to the object calling this method.
01410            It may be used to return dynamic values based on the caller.
01411            XXX:  this is unclear
01412 
01413         o 'default' is returned if no such alias is defined.
01414 
01415         o Permission:  Public
01416 
01417         Returns:  Method ID or default value
01418         """
01419 

Assign method aliases for this type.

o Return True if the operation changed any aliases, else False.

o 'aliases' is the mapping of aliases to be assigned.

o XXX:  define keys and values of the mapping.

o Permission:  Manage portal

Definition at line 1393 of file _tools.py.

01393 
01394     def setMethodAliases(aliases):
01395         """ Assign method aliases for this type.
01396 
01397         o Return True if the operation changed any aliases, else False.
01398 
01399         o 'aliases' is the mapping of aliases to be assigned.
01400 
01401         o XXX:  define keys and values of the mapping.
01402 
01403         o Permission:  Manage portal
01404         """

Here is the caller graph for this function:

Return the "human readable" type name

o Note that it may not map exactly to the 'meta_type', e.g.,
  for l10n/i18n or where a single content class is being
  used twice, under different names.

Definition at line 1343 of file _tools.py.

01343 
01344     def Title():
01345         """ Return the "human readable" type name
01346 
01347         o Note that it may not map exactly to the 'meta_type', e.g.,
01348           for l10n/i18n or where a single content class is being
01349           used twice, under different names.
01350         """

Here is the caller graph for this function:


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