pyams_content.features.review package ⊞

pyams_content.features.review.interfaces

class pyams_content.features.review.interfaces.CommentAddedEvent(object, comment)[source]

Bases: zope.interface.interfaces.ObjectEvent

Comment added event

interface pyams_content.features.review.interfaces.ICommentAddedEvent[source]

Extends: zope.interface.interfaces.IObjectEvent

Comment added event interface

comment

New comment

interface pyams_content.features.review.interfaces.IReviewComment[source]

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

Review comment interface

__parent__
Implementation:zope.schema.Field
Read Only:False
Required:True
Default Value:None
owner

Comment writer

Implementation:pyams_security.schema.Principal
Read Only:False
Required:True
Default Value:None
Allowed Type:str
reviewers

Content reviewers

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

Comment type

Implementation:zope.schema.Choice
Read Only:False
Required:True
Default Value:‘comment’
comment

Comment body

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

Reviewer comment?

Implementation:zope.schema.Bool
Read Only:False
Required:True
Default Value:False
Allowed Type:bool
creation_date

Creation date

Implementation:zope.schema.Datetime
Read Only:False
Required:False
Default Value:None
Allowed Type:datetime.datetime
interface pyams_content.features.review.interfaces.IReviewComments[source]

Extends: zope.container.interfaces.IContainer

Review comments container interface

__setitem__(key, value)

Add the given object to the container under the given name.

Raises a TypeError if the key is not a unicode or ascii string.

Raises a ValueError if the key is empty, or if the key contains a character which is not allowed in an object name.

Raises a KeyError if the key violates a uniqueness constraint.

The container might choose to add a different object than the one passed to this method.

If the object doesn’t implement IContained, then one of two things must be done:

  1. If the object implements ILocation, then the IContained interface must be declared for the object.
  2. Otherwise, a ContainedProxy is created for the object and stored.

The object’s __parent__ and __name__ attributes are set to the container and the given name.

If the old parent was None, then an IObjectAddedEvent is generated, otherwise, an IObjectMovedEvent is generated. An IContainerModifiedEvent is generated for the container.

If the object replaces another object, then the old object is deleted before the new object is added, unless the container vetos the replacement by raising an exception.

If the object’s __parent__ and __name__ were already set to the container and the name, then no events are generated and no hooks. This allows advanced clients to take over event generation.

reviewers

Reviewers list

List of principals which reviewed the comment

Implementation:pyams_security.schema.PrincipalsSet
Read Only:False
Required:False
Default Value:None
Allowed Type:set
clear(self)

Remove all comments

add_comment(self, comment)

Add given comment to list

interface pyams_content.features.review.interfaces.IReviewManager[source]

Content review interface

ask_review(self, reviewers, comment, notify=True)

Ask for content review

interface pyams_content.features.review.interfaces.IReviewTarget[source]

Review target marker interface

This interface is used to mark contents which can handle review.