Back to index

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

List of all members.

Public Member Functions

def setConstrainTypesMode
def setLocallyAllowedTypes
def setImmediatelyAddableTypes
def canSetConstrainTypes
def getConstrainTypesMode
def getLocallyAllowedTypes
def getImmediatelyAddableTypes
def getDefaultAddableTypes
def allowedContentTypes

Detailed Description

Extension to the IConstrainTypes interface for content types which allow
the user to set the allowable content types and immediately available
types.

Definition at line 44 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         """
            
Return True if the current user is permitted to constrain addable
types in this folderish object.

Definition at line 75 of file constrains.py.

00075 
00076     def canSetConstrainTypes():
00077         """
00078         Return True if the current user is permitted to constrain addable
00079         types in this folderish object.
00080         """
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         """
        
Extension to the IConstrainTypes interface for content types which allow
the user to set the allowable content types and immediately available
types.
Set how addable types is controlled in this class. If mode is 0, use
the type's default FTI-set allowable types). If mode is 1, use only
those types explicitly enabled using setLocallyAllowedTypes(). If
mode is -1, acquire the allowable types from the parent. If the parent
portal type is not the same as this object's type, fall back on the
behaviour obtained if mode == 0.

Definition at line 51 of file constrains.py.

00051 
00052     def setConstrainTypesMode(mode):
00053         """
00054         Set how addable types is controlled in this class. If mode is 0, use
00055         the type's default FTI-set allowable types). If mode is 1, use only
00056         those types explicitly enabled using setLocallyAllowedTypes(). If
00057         mode is -1, acquire the allowable types from the parent. If the parent
00058         portal type is not the same as this object's type, fall back on the
00059         behaviour obtained if mode == 0.
00060         """
        
Set the list of type ids which should be immediately/most easily 
addable. This list must be a subset of any types set in 
setLocallyAllowedTypes.

Definition at line 68 of file constrains.py.

00068 
00069     def setImmediatelyAddableTypes(types):
00070         """
00071         Set the list of type ids which should be immediately/most easily 
00072         addable. This list must be a subset of any types set in 
00073         setLocallyAllowedTypes.
00074         """

Set a list of type ids which should be allowed. This must be a 
subset of the type's FTI-set allowable types. This list only comes
into effect when the restrictions mode is 1 (enabled).

Definition at line 61 of file constrains.py.

00061 
00062     def setLocallyAllowedTypes(types):
00063         """
00064         Set a list of type ids which should be allowed. This must be a 
00065         subset of the type's FTI-set allowable types. This list only comes
00066         into effect when the restrictions mode is 1 (enabled).
00067         """
        

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