coarnotify.patterns.request_review

Pattern to represent a Request Review notification https://coar-notify.net/specification/1.0.0/request-review/

Classes

RequestReview

Class to represent a Request Review notification

RequestReviewItem

Custom Request Review Item class to provide the custom validation

RequestReviewObject

Custom Request Review Object class to return the custom RequestReviewItem class

Module Contents

class coarnotify.patterns.request_review.RequestReview(stream: coarnotify.core.activitystreams2.ActivityStream | dict = None, validate_stream_on_construct=True, validate_properties=True, validators=None, validation_context=None, properties_by_reference=True)

Bases: coarnotify.core.notify.NotifyPattern

Class to represent a Request Review notification

TYPE

Request Review types, including an ActivityStreams offer and a COAR Notify Review Action

property object: RequestReviewObject | None

Custom getter to retrieve the object property as a RequestReviewObject :return:

class coarnotify.patterns.request_review.RequestReviewItem(stream: coarnotify.core.activitystreams2.ActivityStream | dict = None, validate_stream_on_construct=True, validate_properties=True, validators=None, validation_context=None, properties_by_reference=True)

Bases: coarnotify.core.notify.NotifyItem

Custom Request Review Item class to provide the custom validation

validate() → bool

Extend the base validation to include the following constraints:

  • The type property is required and must validate

  • the mediaType property is required

Returns:

True if validation passes, else raise a ValidationError

class coarnotify.patterns.request_review.RequestReviewObject(stream: coarnotify.core.activitystreams2.ActivityStream | dict = None, validate_stream_on_construct=True, validate_properties=True, validators=None, validation_context=None, properties_by_reference=True)

Bases: coarnotify.core.notify.NotifyObject

Custom Request Review Object class to return the custom RequestReviewItem class

property item: RequestReviewItem | None

Custom getter to retrieve the item property as a RequestReviewItem :return: