agency.models.ticket

Classes

AgencyMutationTicket

Adds additional methods to the ticket, needed by the organisations

PersonMutationTicket

Adds additional methods to the ticket, needed by the organisations

AgencyMutationHandler

Defines a generic handler, responsible for a subset of the tickets.

PersonMutationHandler

Defines a generic handler, responsible for a subset of the tickets.

Module Contents

class agency.models.ticket.AgencyMutationTicket[source]

Bases: onegov.org.models.ticket.OrgTicketMixin, onegov.ticket.Ticket

Adds additional methods to the ticket, needed by the organisations implementation of it. Strictly limited to things that do not belong into onegov.ticket.

__mapper_args__[source]
es_type_name = 'agency_tickets'[source]
reference_group(request: onegov.org.request.OrgRequest) str[source]
class agency.models.ticket.PersonMutationTicket[source]

Bases: onegov.org.models.ticket.OrgTicketMixin, onegov.ticket.Ticket

Adds additional methods to the ticket, needed by the organisations implementation of it. Strictly limited to things that do not belong into onegov.ticket.

__mapper_args__[source]
es_type_name = 'person_tickets'[source]
reference_group(request: onegov.org.request.OrgRequest) str[source]
class agency.models.ticket.AgencyMutationHandler(ticket: onegov.ticket.model.Ticket, handler_id: UUID | str, handler_data: dict[str, Any])[source]

Bases: onegov.ticket.Handler

Defines a generic handler, responsible for a subset of the tickets.

onegov.ticket is meant to be a rather generic bucket of tickets, to which varying modules submit tickets with varying content and different actionables.

Each module wanting to submit tickets needs to implement a handler with a unique id and a unique short code. The short code is added in front of the ticket number.

Tickets submitted to the database are shown in a list, without handler involvement. When a ticket is displayed, the handler is called with whatever data the handler supplied during ticket submission.

The handler then uses the handler data to access whatever data it needs to display a summary as well as links to certain actions (possibly a link to the original item, links that change the state of the ticket as well as the data associated with the handler, etc.).

handler_title[source]
code_title[source]
collection() onegov.agency.collections.ExtendedAgencyCollection[source]
agency() ExtendedAgency | None[source]
mutation() onegov.agency.models.AgencyMutation | None[source]
property deleted: bool[source]

Returns true if the underlying model was deleted. It is best to never let that happen, as we want tickets to stay around forever.

However, this can make sense in certain scenarios. Note that if you do delete your underlying model, make sure to call onegov.ticket.models.Ticket.create_snapshot() beforehand!

email() str[source]

Returns the email address behind the ticket request.

message() str[source]
proposed_changes() dict[str, Any][source]
state() str | None[source]
property title: str[source]

Returns the title of the ticket. If this title may change over time, the handler must call self.refresh() when there’s a change.

property subtitle: str[source]

Returns the subtitle of the ticket. If this title may change over time, the handler must call self.refresh() when there’s a change.

group() str[source]

Returns the group of the ticket. If this group may change over time, the handler must call self.refresh() when there’s a change.

get_summary(request: onegov.agency.request.AgencyRequest) str[source]

Returns the summary of the current ticket as a html string.

Returns the links associated with the current ticket in the following format:

[
    ('Link Title', 'http://link'),
    ('Link Title 2', 'http://link2'),
]

If the links are not tuples, but callables, they will be called with the request which should return the rendered link.

class agency.models.ticket.PersonMutationHandler(ticket: onegov.ticket.model.Ticket, handler_id: UUID | str, handler_data: dict[str, Any])[source]

Bases: onegov.ticket.Handler

Defines a generic handler, responsible for a subset of the tickets.

onegov.ticket is meant to be a rather generic bucket of tickets, to which varying modules submit tickets with varying content and different actionables.

Each module wanting to submit tickets needs to implement a handler with a unique id and a unique short code. The short code is added in front of the ticket number.

Tickets submitted to the database are shown in a list, without handler involvement. When a ticket is displayed, the handler is called with whatever data the handler supplied during ticket submission.

The handler then uses the handler data to access whatever data it needs to display a summary as well as links to certain actions (possibly a link to the original item, links that change the state of the ticket as well as the data associated with the handler, etc.).

handler_title[source]
code_title[source]
collection() onegov.agency.collections.ExtendedPersonCollection[source]
person() ExtendedPerson | None[source]
mutation() onegov.agency.models.PersonMutation | None[source]
property deleted: bool[source]

Returns true if the underlying model was deleted. It is best to never let that happen, as we want tickets to stay around forever.

However, this can make sense in certain scenarios. Note that if you do delete your underlying model, make sure to call onegov.ticket.models.Ticket.create_snapshot() beforehand!

email() str[source]

Returns the email address behind the ticket request.

message() str[source]
proposed_changes() dict[str, Any][source]
state() str | None[source]
property title: str[source]

Returns the title of the ticket. If this title may change over time, the handler must call self.refresh() when there’s a change.

property subtitle: str[source]

Returns the subtitle of the ticket. If this title may change over time, the handler must call self.refresh() when there’s a change.

group() str[source]

Returns the group of the ticket. If this group may change over time, the handler must call self.refresh() when there’s a change.

get_summary(request: onegov.agency.request.AgencyRequest) str[source]

Returns the summary of the current ticket as a html string.

Returns the links associated with the current ticket in the following format:

[
    ('Link Title', 'http://link'),
    ('Link Title 2', 'http://link2'),
]

If the links are not tuples, but callables, they will be called with the request which should return the rendered link.