pyams_content.interfaces package ⊞

pyams_content.interfaces.COMMENT_CONTENT_PERMISSION = 'pyams.CommentContent'

Permission required to add comments on an existing content

pyams_content.interfaces.CONTRIBUTOR_ROLE = 'pyams.Contributor'

Contributor role is allowed to create new contents

pyams_content.interfaces.CREATE_CONTENT_PERMISSION = 'pyams.CreateContent'

Permission required to create a new content

pyams_content.interfaces.CREATE_VERSION_PERMISSION = 'pyams.CreateVersion'

Permission required to create a new version of an existing content

pyams_content.interfaces.GUEST_ROLE = 'pyams.Guest'

Guest role is allowed to view contents

interface pyams_content.interfaces.IBaseContent

Extends: zope.location.interfaces.IContained, zope.annotation.interfaces.IAttributeAnnotatable

Base content interface

__name__

Unique key

WARNING: this key can’t be modified after creation!!! Spaces, uppercase letters ou accentuated characters will be replaced automatically.

Implementation:zope.schema.TextLine Read Only:False Required:True Default Value:None Allowed Type:str

title

Title

Visible label used to display content

Implementation:pyams_i18n.schema.I18nTextLineField Read Only:False Required:True Default Value:None Allowed Type:dict

Key Type

Implementation:zope.schema.TextLine Read Only:False Required:True Default Value:None Allowed Type:str

Value Type

Implementation:zope.schema.TextLine Read Only:False Required:False Default Value:None Allowed Type:str

short_name

Short name

Short name used in breadcrumbs

Implementation:pyams_i18n.schema.I18nTextLineField Read Only:False Required:True Default Value:None Allowed Type:dict

Key Type

Implementation:zope.schema.TextLine Read Only:False Required:True Default Value:None Allowed Type:str

Value Type

Implementation:zope.schema.TextLine Read Only:False Required:False Default Value:None Allowed Type:str

interface pyams_content.interfaces.IBaseContentInfo

Base content info interface

created_date

Creation date

Implementation:zope.schema.Datetime Read Only:True Required:False Default Value:None Allowed Type:datetime.datetime

modified_date

Modification date

Implementation:zope.schema.Datetime Read Only:False Required:False Default Value:None Allowed Type:datetime.datetime

pyams_content.interfaces.MANAGER_ROLE = 'pyams.Manager'

Manager role is allowed to manage contents workflow

pyams_content.interfaces.MANAGE_CONTENT_PERMISSION = 'pyams.ManageContent'

Permission required to manager properties of an existing content

pyams_content.interfaces.MANAGE_SITE_PERMISSION = 'pyams.ManageSite'

Permission required to manager inner site or blog properties

pyams_content.interfaces.MANAGE_SITE_ROOT_PERMISSION = 'pyams.ManageSiteRoot'

Permission required to manage main site root properties

pyams_content.interfaces.MANAGE_TOOL_PERMISSION = 'pyams.ManageTool'

Permission required to manager shared tool properties

pyams_content.interfaces.OPERATOR_ROLE = 'pyams.Operator'

Operator role is allowed to access management interface

pyams_content.interfaces.OWNER_ROLE = 'pyams.Owner'

Content owner role is allowed to manage content properties until publication

pyams_content.interfaces.PILOT_ROLE = 'pyams.Pilot'

Pilot role is allowed to manage tools configuration and permissions

pyams_content.interfaces.PUBLISH_CONTENT_PERMISSION = 'pyams.PublishContent'

Permission required to publish or retire an existing content

pyams_content.interfaces.READER_ROLE = 'pyams.Reader'

Reader role is allowed to read and comment contents while still in draft state

pyams_content.interfaces.WEBMASTER_ROLE = 'pyams.Webmaster'

Webmaster role has all permissions on all contents

pyams_content.interfaces.container

interface pyams_content.interfaces.container.IOrderedContainer

Extends: zope.container.interfaces.IContainer, pyams_content.interfaces.container.IOrderedContainerOrder

Marker interface for ordered containers

interface pyams_content.interfaces.container.IOrderedContainerOrder

Ordered containers interface

updateOrder(self, order)

Reset items in given order

@order: new ordered list of container’s items keys

moveFirst(self, key)

Move item with given key to first position

moveUp(self, key)

Move item with given key one position up

moveDown(self, key)

Move item with given key one position down

moveLast(self, key)

Move item with given key to last position