Interactions

This package contains all data models related to interactions between users and offers: Comment, Favorite, Report and Vote.

Comment

class integreat_compass.cms.models.interactions.comment.Comment(*args, **kwargs)

Bases: AbstractBaseModel

Data model representing a Comment.

Parameters:

id (BigAutoField) – Primary key: ID
date (DateTimeField) – Date
comment (TextField) – Comment. Additional context for the given rating
rating (PositiveSmallIntegerField) – Rating. Rating of the offer

Relationship fields:

Parameters:

creator (ForeignKey to User) – Creator (related name: comments)
offer_version (ForeignKey to OfferVersion) – Offer version (related name: comments)

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

comment

Type: TextField

Comment. Additional context for the given rating

creator

Type: ForeignKey to User

Creator (related name: comments)

creator_id: Internal field, use creator instead.

date

Type: DateTimeField

Date

get_next_by_date(*, field=<django.db.models.DateTimeField: date>, is_next=True, **kwargs): Finds next instance based on date. See get_next_by_FOO() for more information.

get_previous_by_date(*, field=<django.db.models.DateTimeField: date>, is_next=False, **kwargs): Finds previous instance based on date. See get_previous_by_FOO() for more information.

get_repr()

This overwrites the default Django __repr__() method which would return <Comment: Comment object (id)>. It is used for logging.

Returns:: The canonical string representation of the page
Return type:: str

id

Type: BigAutoField

Primary key: ID

objects = <django.db.models.Manager object>

offer_version

Type: ForeignKey to OfferVersion

Offer version (related name: comments)

offer_version_id: Internal field, use offer_version instead.

rating

Type: PositiveSmallIntegerField

Rating. Rating of the offer

Favorite

class integreat_compass.cms.models.interactions.favorite.Favorite(*args, **kwargs)

Bases: AbstractBaseModel

Data model representing a Favorite.

Parameters:: id (BigAutoField) – Primary key: ID

Relationship fields:

Parameters:

creator (ForeignKey to User) – Creator (related name: favorite)
offer (ForeignKey to Offer) – Offer (related name: favorite)

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

creator

Type: ForeignKey to User

Creator (related name: favorite)

creator_id: Internal field, use creator instead.

get_repr()

This overwrites the default Django __repr__() method which would return <Favorite: Favorite object (id)>. It is used for logging.

Returns:: The canonical string representation of the page
Return type:: str

id

Type: BigAutoField

Primary key: ID

objects = <django.db.models.Manager object>

offer

Type: ForeignKey to Offer

Offer (related name: favorite)

offer_id: Internal field, use offer instead.

Report

class integreat_compass.cms.models.interactions.report.Report(*args, **kwargs)

Bases: AbstractBaseModel

Data model representing a Report.

Parameters:

id (BigAutoField) – Primary key: ID
comment (TextField) – Comment. Reason for the report

Relationship fields:

Parameters:: offer_version (ForeignKey to OfferVersion) – Offer version (related name: reports)

exception DoesNotExist: Bases: ObjectDoesNotExist

exception MultipleObjectsReturned: Bases: MultipleObjectsReturned

comment

Type: TextField

Comment. Reason for the report

get_repr()

This overwrites the default Django __repr__() method which would return <Report: Report object (id)>. It is used for logging.

Returns:: The canonical string representation of the page
Return type:: str

id

Type: BigAutoField

Primary key: ID

objects = <django.db.models.Manager object>

offer_version

Type: ForeignKey to OfferVersion

Offer version (related name: reports)

offer_version_id: Internal field, use offer_version instead.

Vote

class integreat_compass.cms.models.interactions.vote.Vote(*args, **kwargs)

Bases: AbstractBaseModel

Data model representing a Vote.

Parameters:

id (BigAutoField) – Primary key: ID
approval (BooleanField) – Approval. Whether the vote approves or disapproves of an offer
comment (TextField) – Comment. Reason for approving or disapproving an offer

Relationship fields:

Parameters:

creator (ForeignKey to User) – Creator (related name: votes)
offer_version (ForeignKey to OfferVersion) – Offer version (related name: votes)