Back to index

plone3  3.1.7
Public Member Functions
CMFPlone.interfaces.constrains.IConstrainTypes Class Reference
Inheritance diagram for CMFPlone.interfaces.constrains.IConstrainTypes:
Inheritance graph
[legend]
Collaboration diagram for CMFPlone.interfaces.constrains.IConstrainTypes:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def getConstrainTypesMode
def getLocallyAllowedTypes
def getImmediatelyAddableTypes
def getDefaultAddableTypes
def allowedContentTypes

Detailed Description

Interface for folderish content types supporting restricting addable types 
on a per-instance basis.

Definition at line 3 of file constrains.py.


Member Function Documentation

Return the list of currently permitted FTIs.

Definition at line 39 of file constrains.py.

00039 
00040     def allowedContentTypes():
00041         """
00042         Return the list of currently permitted FTIs.
00043         """
            
Find out if add-restrictions are enabled. Returns 0 if they are 
disabled (the type's default FTI-set allowable types is in effect), 
1 if they are enabled (only a selected subset if allowed types will be
available), and -1 if the allowed types should be acquired from the
parent. Note that in this case, if the parent portal type is not the 
same as the portal type of this object, fall back on the default (same
as 0)

Definition at line 9 of file constrains.py.

00009 
00010     def getConstrainTypesMode():
00011         """
00012         Find out if add-restrictions are enabled. Returns 0 if they are 
00013         disabled (the type's default FTI-set allowable types is in effect), 
00014         1 if they are enabled (only a selected subset if allowed types will be
00015         available), and -1 if the allowed types should be acquired from the
00016         parent. Note that in this case, if the parent portal type is not the 
00017         same as the portal type of this object, fall back on the default (same
00018         as 0)
00019         """
        

Here is the caller graph for this function:

Return a list of FTIs which correspond to the list of FTIs available
when the constraint mode = 0 (that is, the types addable without any
setLocallyAllowedTypes trickery involved)

Definition at line 32 of file constrains.py.

00032 
00033     def getDefaultAddableTypes():
00034         """
00035         Return a list of FTIs which correspond to the list of FTIs available
00036         when the constraint mode = 0 (that is, the types addable without any
00037         setLocallyAllowedTypes trickery involved)
00038         """
        
Return a subset of the FTI ids from getLocallyAllowedTypes() which 
should be made most easily available.

Definition at line 26 of file constrains.py.

00026 
00027     def getImmediatelyAddableTypes():
00028         """
00029         Return a subset of the FTI ids from getLocallyAllowedTypes() which 
00030         should be made most easily available.
00031         """
        
Get the list of FTI ids for the types which should be allowed to be
added in this container.

Definition at line 20 of file constrains.py.

00020 
00021     def getLocallyAllowedTypes():
00022         """
00023         Get the list of FTI ids for the types which should be allowed to be
00024         added in this container.
00025         """
        

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