Back to index

plone3  3.1.7
Public Member Functions
CMFEditions.interfaces.IRepository.IContentTypeVersionPolicySupport Class Reference
Inheritance diagram for CMFEditions.interfaces.IRepository.IContentTypeVersionPolicySupport:
Inheritance graph
[legend]
Collaboration diagram for CMFEditions.interfaces.IRepository.IContentTypeVersionPolicySupport:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def addPolicyForContentType
def removePolicyFromContentType
def supportsPolicy
def hasPolicy
def manage_setTypePolicies
def listPolicies
def addPolicy
def removePolicy
def manage_changePolicyDefs
def getPolicyMap
def getVersionableContentTypes
def setVersionableContentTypes
def isVersionable

Detailed Description

Determine if a type supports a particular versioning method, the policy
   parameter is simply a string representing the policy

Definition at line 266 of file IRepository.py.


Member Function Documentation

def CMFEditions.interfaces.IRepository.IContentTypeVersionPolicySupport.addPolicy (   policy_id,
  policy_title,
  policy_class 
)
Add a new versioning policy, can optionally use an alternate
   policy class.

Definition at line 291 of file IRepository.py.

00291 
00292     def addPolicy(policy_id, policy_title, policy_class):
00293         """Add a new versioning policy, can optionally use an alternate
00294            policy class."""

Determine if a type supports a particular versioning method, the policy
   parameter is simply a string representing the policy
Sets a content type to use a specific policy

Definition at line 270 of file IRepository.py.

00270 
00271     def addPolicyForContentType(content_type, policy):
00272         """Sets a content type to use a specific policy"""

Return a mapping of types to the lists of policies they support,
   for use in config screen.

Definition at line 306 of file IRepository.py.

00306 
00307     def getPolicyMap():
00308         """Return a mapping of types to the lists of policies they support,
00309            for use in config screen."""
00310 

Registry for versionable content types
Returns a list of Versionable content types

Definition at line 258 of file IRepository.py.

00258 
00259     def getVersionableContentTypes():
00260         """Returns a list of Versionable content types
00261         """

Determine if an object has any assigned versioning policies

Definition at line 280 of file IRepository.py.

00280 
00281     def hasPolicy(obj):
00282         """Determine if an object has any assigned versioning policies"""

Check if versioning is supported for a specific content.
Returns True if the object is versionable

Definition at line 249 of file IRepository.py.

00249 
00250     def isVersionable(obj):
00251         """Returns True if the object is versionable
00252         """
00253 

Return a sequence of all defined VersionPolicy objects

Definition at line 288 of file IRepository.py.

00288 
00289     def listPolicies():
00290         """Return a sequence of all defined VersionPolicy objects"""

Update the policy structure with a list of tuples [(id, title),...]
   The tuples may optionally contain a policy class and a dict of
   kwargs to pass to the policy add hook. e.g.:
  [(id, title, klass, {'arg1': val1}), ...]

Definition at line 299 of file IRepository.py.

00299 
00300     def manage_changePolicyDefs(policy_list):
00301         """Update the policy structure with a list of tuples [(id, title),...]
00302            The tuples may optionally contain a policy class and a dict of
00303            kwargs to pass to the policy add hook. e.g.:
00304           [(id, title, klass, {'arg1': val1}), ...]
00305         """

Set the policy_mapping for all types from a dict of
content_type : policy list mappings {content_type: [policy1, policy2]}

Definition at line 283 of file IRepository.py.

00283 
00284     def manage_setTypePolicies(policy_map):
00285         """Set the policy_mapping for all types from a dict of
00286         content_type : policy list mappings {content_type: [policy1, policy2]}
00287         """

Removes a versioning policy from the tool and all types which
   support it

Definition at line 295 of file IRepository.py.

00295 
00296     def removePolicy(policy_id):
00297         """Removes a versioning policy from the tool and all types which
00298            support it"""

Sets a content type to use a specific policy

Definition at line 273 of file IRepository.py.

00273 
00274     def removePolicyFromContentType(content_type, policy):
00275         """Sets a content type to use a specific policy"""

Set the list of Versionable content types

Definition at line 262 of file IRepository.py.

00262 
00263     def setVersionableContentTypes(new_content_types):
00264         """Set the list of Versionable content types
00265         """

Determine if an object is set to use a specific versioning policy

Definition at line 276 of file IRepository.py.

00276 
00277     def supportsPolicy(obj, policy):
00278         """Determine if an object is set to use a specific versioning policy
00279         """


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