from onegov.core.orm import Base
from onegov.core.orm.mixins import TimestampMixin
from onegov.core.orm.types import UUID
from sqlalchemy import Boolean
from sqlalchemy import Column
from sqlalchemy import ForeignKey
from sqlalchemy import Text
from sqlalchemy import UniqueConstraint
from sqlalchemy.dialects.postgresql import INT4RANGE
from sqlalchemy.orm import relationship
from uuid import uuid4
from typing import TYPE_CHECKING
if TYPE_CHECKING:
import uuid
from onegov.activity.types import BoundedIntegerRange
from .occasion import Occasion
from .volunteer import Volunteer
[docs]
class OccasionNeed(Base, TimestampMixin):
""" Defines a required resource on an occasion. """
[docs]
__tablename__ = 'occasion_needs'
#: the public id of this occasion resource
[docs]
id: 'Column[uuid.UUID]' = Column(
UUID, # type:ignore[arg-type]
primary_key=True,
default=uuid4
)
#: the name of the occasion resource
[docs]
name: 'Column[str]' = Column(Text, nullable=False)
#: a description of the occasion resource
[docs]
description: 'Column[str | None]' = Column(Text, nullable=True)
#: the required range of resources
[docs]
number: 'Column[BoundedIntegerRange]' = Column(INT4RANGE, nullable=False)
#: true if volunteers may sign up for this
[docs]
accept_signups: 'Column[bool]' = Column(
Boolean,
nullable=False,
default=False
)
#: The associated occasion
[docs]
occasion_id: 'Column[uuid.UUID]' = Column(
UUID, # type:ignore[arg-type]
ForeignKey('occasions.id'),
nullable=False
)
[docs]
occasion: 'relationship[Occasion]' = relationship(
'Occasion',
back_populates='needs'
)
[docs]
volunteers: 'relationship[list[Volunteer]]' = relationship(
'Volunteer',
back_populates='need',
cascade='all, delete-orphan'
)
[docs]
__table_args__ = (
UniqueConstraint(
'name', 'occasion_id', name='unique_need_per_occasion'),
)