Organizations

This package contains all views related to organizations

Organization Actions

This module contains action methods for organizations (archive, restore)

integreat_cms.cms.views.organizations.organization_actions.archive(request: HttpRequest, region_slug: str, organization_id: int) → HttpResponseRedirect

Set archived flag for an organization

Parameters:

• request (HttpRequest) – Object representing the user call

• region_slug (str) – slug of the region to which an organization belongs

• organization_id (int) – id of the event to be archived

Returns:

The rendered template response

Return type:

HttpResponseRedirect

integreat_cms.cms.views.organizations.organization_actions.delete(request: HttpRequest, region_slug: str, organization_id: int) → HttpResponseRedirect

Delete a single organization

Parameters:

• request (HttpRequest) – Object representing the user call

• region_slug (str) – slug of the region which the organization belongs to

• organization_id (int) – id of the event to be deleted

Returns:

The rendered template response

Return type:

HttpResponseRedirect

integreat_cms.cms.views.organizations.organization_actions.restore(request: HttpRequest, region_slug: str, organization_id: int) → HttpResponseRedirect

Remove archived flag for an organization

Parameters:

• request (HttpRequest) – Object representing the user call

• region_slug (str) – slug of the region to which the organization belongs

• organization_id (int) – id of the event to be restored

Returns:

The rendered template response

Return type:

HttpResponseRedirect

Organization Bulk Actions

class integreat_cms.cms.views.organizations.organization_bulk_actions.ArchiveBulkAction(**kwargs)

Bases: OrganizationBulkAction

Bulk action for archiving multiple organizations

__init__(**kwargs)

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

allow_empty = True

classmethod as_view(**initkwargs)

Main entry point for a request-response process.

context_object_name = None

delete(request, *args, **kwargs)

dispatch(request, *args, **kwargs)

extra_context = None

get(request, *args, **kwargs)

get_allow_empty()

Return True if the view should display empty lists and False if a 404 should be raised instead.

get_context_data(*, object_list=None, **kwargs)

Get the context for this view.

get_context_object_name(object_list)

Get the name of the item to be used in the context.

get_extra_filters() → Q

Get extra filters for get_queryset(). Overwrite this method to specify needed filters e.g. as in ~integreat_cms.cms.views.contact.contact_bulk_actions

Returns:

Q Object to be used as filter argument

Return type:

Q

get_login_url()

Override this method to override the login_url attribute.

get_ordering()

Return the field or fields to use for ordering the queryset.

get_paginate_by(queryset)

Get the number of items to paginate by, or None for no pagination.

get_paginate_orphans()

Return the maximum number of orphans extend the last page by when paginating.

get_paginator(queryset, per_page, orphans=0, allow_empty_first_page=True, **kwargs)

Return an instance of the paginator for this view.

get_permission_denied_message()

Override this method to override the permission_denied_message attribute.

get_permission_required() → tuple[str]

Override this method to override the permission_required attribute.

Returns:

The permissions that are required for views inheriting from this Mixin

Return type:

tuple[str]

get_queryset() → Any

Get the queryset of selected items for this bulk action

Raises:

Http404 – HTTP status 404 if no objects with the given ids exist

Returns:

The QuerySet of the filtered links

Return type:

Any

get_redirect_field_name()

Override this method to override the redirect_field_name attribute.

get_redirect_url(*args: Any, **kwargs: Any) → str

Retrieve url for redirection

Parameters:

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Returns:

url to redirect to

Return type:

str

handle_no_permission()

has_permission()

Override this method to customize the way permissions are checked.

head(request, *args, **kwargs)

http_method_names: list[str] = ['post']

The list of HTTP method names that this view will accept. The bulk action form uses only POST as submission method.

http_method_not_allowed(request, *args, **kwargs)

login_url = None

model

alias of Organization

options(request, *args, **kwargs)

Handle responding to requests for the OPTIONS HTTP verb.

ordering = None

page_kwarg = 'page'

paginate_by = None

paginate_orphans = 0

paginate_queryset(queryset, page_size)

Paginate the queryset, if needed.

paginator_class

alias of Paginator

patch(request, *args, **kwargs)

pattern_name = None

permanent = False

permission_denied_message = ''

permission_required = None

post(request: HttpRequest, *args: Any, **kwargs: Any) → HttpResponse

Function to archive multiple organizations at once

Parameters:

• request (HttpRequest) – The current request

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Returns:

The redirect

Return type:

HttpResponse

prefetch_public_translations: bool = False

Whether the public translation objects should be prefetched

prefetch_translations: bool = False

Whether the translation objects should be prefetched

put(request, *args, **kwargs)

query_string = False

queryset = None

raise_exception = False

redirect_field_name = 'next'

require_change_permission: bool = True

Whether the view requires change permissions

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

url = None

view_is_async = False

class integreat_cms.cms.views.organizations.organization_bulk_actions.DeleteBulkAction(**kwargs)

Bases: OrganizationBulkAction

Bulk action for deleting multiple organizations

__init__(**kwargs)

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

allow_empty = True

classmethod as_view(**initkwargs)

Main entry point for a request-response process.

context_object_name = None

delete(request, *args, **kwargs)

dispatch(request, *args, **kwargs)

extra_context = None

get(request, *args, **kwargs)

get_allow_empty()

Return True if the view should display empty lists and False if a 404 should be raised instead.

get_context_data(*, object_list=None, **kwargs)

Get the context for this view.

get_context_object_name(object_list)

Get the name of the item to be used in the context.

get_extra_filters() → Q

Get extra filters for get_queryset(). Overwrite this method to specify needed filters e.g. as in ~integreat_cms.cms.views.contact.contact_bulk_actions

Returns:

Q Object to be used as filter argument

Return type:

Q

get_login_url()

Override this method to override the login_url attribute.

get_ordering()

Return the field or fields to use for ordering the queryset.

get_paginate_by(queryset)

Get the number of items to paginate by, or None for no pagination.

get_paginate_orphans()

Return the maximum number of orphans extend the last page by when paginating.

get_paginator(queryset, per_page, orphans=0, allow_empty_first_page=True, **kwargs)

Return an instance of the paginator for this view.

get_permission_denied_message()

Override this method to override the permission_denied_message attribute.

get_permission_required() → tuple[str]

This method overwrites get_permission_required() :return: The needed permission to delete contacts

Return type:

tuple[str]

get_queryset() → Any

Get the queryset of selected items for this bulk action

Raises:

Http404 – HTTP status 404 if no objects with the given ids exist

Returns:

The QuerySet of the filtered links

Return type:

Any

get_redirect_field_name()

Override this method to override the redirect_field_name attribute.

get_redirect_url(*args: Any, **kwargs: Any) → str

Retrieve url for redirection

Parameters:

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Returns:

url to redirect to

Return type:

str

handle_no_permission()

has_permission()

Override this method to customize the way permissions are checked.

head(request, *args, **kwargs)

http_method_names: list[str] = ['post']

The list of HTTP method names that this view will accept. The bulk action form uses only POST as submission method.

http_method_not_allowed(request, *args, **kwargs)

login_url = None

model

alias of Organization

options(request, *args, **kwargs)

Handle responding to requests for the OPTIONS HTTP verb.

ordering = None

page_kwarg = 'page'

paginate_by = None

paginate_orphans = 0

paginate_queryset(queryset, page_size)

Paginate the queryset, if needed.

paginator_class

alias of Paginator

patch(request, *args, **kwargs)

pattern_name = None

permanent = False

permission_denied_message = ''

permission_required = None

post(request: HttpRequest, *args: Any, **kwargs: Any) → HttpResponse

Function to delete multiple organizations at once

Parameters:

• request (HttpRequest) – The current request

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Returns:

The redirect

Return type:

HttpResponse

prefetch_public_translations: bool = False

Whether the public translation objects should be prefetched

prefetch_translations: bool = False

Whether the translation objects should be prefetched

put(request, *args, **kwargs)

query_string = False

queryset = None

raise_exception = False

redirect_field_name = 'next'

require_change_permission: bool = True

Whether the view requires change permissions

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

url = None

view_is_async = False

class integreat_cms.cms.views.organizations.organization_bulk_actions.OrganizationBulkAction(**kwargs)

Bases: BulkActionView

View for executing organization bulk actions

__init__(**kwargs)

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

allow_empty = True

classmethod as_view(**initkwargs)

Main entry point for a request-response process.

context_object_name = None

delete(request, *args, **kwargs)

dispatch(request, *args, **kwargs)

extra_context = None

get(request, *args, **kwargs)

get_allow_empty()

Return True if the view should display empty lists and False if a 404 should be raised instead.

get_context_data(*, object_list=None, **kwargs)

Get the context for this view.

get_context_object_name(object_list)

Get the name of the item to be used in the context.

get_extra_filters() → Q

Get extra filters for get_queryset(). Overwrite this method to specify needed filters e.g. as in ~integreat_cms.cms.views.contact.contact_bulk_actions

Returns:

Q Object to be used as filter argument

Return type:

Q

get_login_url()

Override this method to override the login_url attribute.

get_ordering()

Return the field or fields to use for ordering the queryset.

get_paginate_by(queryset)

Get the number of items to paginate by, or None for no pagination.

get_paginate_orphans()

Return the maximum number of orphans extend the last page by when paginating.

get_paginator(queryset, per_page, orphans=0, allow_empty_first_page=True, **kwargs)

Return an instance of the paginator for this view.

get_permission_denied_message()

Override this method to override the permission_denied_message attribute.

get_permission_required() → tuple[str]

Override this method to override the permission_required attribute.

Returns:

The permissions that are required for views inheriting from this Mixin

Return type:

tuple[str]

get_queryset() → Any

Get the queryset of selected items for this bulk action

Raises:

Http404 – HTTP status 404 if no objects with the given ids exist

Returns:

The QuerySet of the filtered links

Return type:

Any

get_redirect_field_name()

Override this method to override the redirect_field_name attribute.

get_redirect_url(*args: Any, **kwargs: Any) → str

Retrieve url for redirection

Parameters:

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Returns:

url to redirect to

Return type:

str

handle_no_permission()

has_permission()

Override this method to customize the way permissions are checked.

head(request, *args, **kwargs)

http_method_names: list[str] = ['post']

The list of HTTP method names that this view will accept. The bulk action form uses only POST as submission method.

http_method_not_allowed(request, *args, **kwargs)

login_url = None

model

The model of this BulkActionView

Parameters:

• id (BigAutoField) – Primary key: ID

• name (CharField) – Name

• slug (SlugField) – Slug. Unique string identifier without spaces and special characters.

• last_updated (DateTimeField) – Modification date

• created_date (DateTimeField) – Creation date

• website (URLField) – Website

• archived (BooleanField) – Archived

Relationship fields:

Parameters:

• icon (ForeignKey to MediaFile) – Logo (related name: icon_organizations)

• region (ForeignKey to Region) – Region (related name: organizations)

• links (GenericRelation to Link) – Links (related name: organization)

Reverse relationships:

Parameters:

• pois (Reverse ForeignKey from POI) – All pois of this organization (related name of organization)

• pages (Reverse ForeignKey from Page) – All pages of this organization (related name of organization)

• members (Reverse ForeignKey from User) – All members of this organization (related name of organization)

alias of Organization

options(request, *args, **kwargs)

Handle responding to requests for the OPTIONS HTTP verb.

ordering = None

page_kwarg = 'page'

paginate_by = None

paginate_orphans = 0

paginate_queryset(queryset, page_size)

Paginate the queryset, if needed.

paginator_class

alias of Paginator

patch(request, *args, **kwargs)

pattern_name = None

permanent = False

permission_denied_message = ''

permission_required = None

post(request, *args, **kwargs)

prefetch_public_translations: bool = False

Whether the public translation objects should be prefetched

prefetch_translations: bool = False

Whether the translation objects should be prefetched

put(request, *args, **kwargs)

query_string = False

queryset = None

raise_exception = False

redirect_field_name = 'next'

require_change_permission: bool = True

Whether the view requires change permissions

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

url = None

view_is_async = False

class integreat_cms.cms.views.organizations.organization_bulk_actions.RestoreBulkAction(**kwargs)

Bases: OrganizationBulkAction

Bulk action for restoring multiple organizations

__init__(**kwargs)

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

allow_empty = True

classmethod as_view(**initkwargs)

Main entry point for a request-response process.

context_object_name = None

delete(request, *args, **kwargs)

dispatch(request, *args, **kwargs)

extra_context = None

get(request, *args, **kwargs)

get_allow_empty()

Return True if the view should display empty lists and False if a 404 should be raised instead.

get_context_data(*, object_list=None, **kwargs)

Get the context for this view.

get_context_object_name(object_list)

Get the name of the item to be used in the context.

get_extra_filters() → Q

Get extra filters for get_queryset(). Overwrite this method to specify needed filters e.g. as in ~integreat_cms.cms.views.contact.contact_bulk_actions

Returns:

Q Object to be used as filter argument

Return type:

Q

get_login_url()

Override this method to override the login_url attribute.

get_ordering()

Return the field or fields to use for ordering the queryset.

get_paginate_by(queryset)

Get the number of items to paginate by, or None for no pagination.

get_paginate_orphans()

Return the maximum number of orphans extend the last page by when paginating.

get_paginator(queryset, per_page, orphans=0, allow_empty_first_page=True, **kwargs)

Return an instance of the paginator for this view.

get_permission_denied_message()

Override this method to override the permission_denied_message attribute.

get_permission_required() → tuple[str]

Override this method to override the permission_required attribute.

Returns:

The permissions that are required for views inheriting from this Mixin

Return type:

tuple[str]

get_queryset() → Any

Get the queryset of selected items for this bulk action

Raises:

Http404 – HTTP status 404 if no objects with the given ids exist

Returns:

The QuerySet of the filtered links

Return type:

Any

get_redirect_field_name()

Override this method to override the redirect_field_name attribute.

get_redirect_url(*args: Any, **kwargs: Any) → str

Retrieve url for redirection

Parameters:

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Returns:

url to redirect to

Return type:

str

handle_no_permission()

has_permission()

Override this method to customize the way permissions are checked.

head(request, *args, **kwargs)

http_method_names: list[str] = ['post']

The list of HTTP method names that this view will accept. The bulk action form uses only POST as submission method.

http_method_not_allowed(request, *args, **kwargs)

login_url = None

model

alias of Organization

options(request, *args, **kwargs)

Handle responding to requests for the OPTIONS HTTP verb.

ordering = None

page_kwarg = 'page'

paginate_by = None

paginate_orphans = 0

paginate_queryset(queryset, page_size)

Paginate the queryset, if needed.

paginator_class

alias of Paginator

patch(request, *args, **kwargs)

pattern_name = None

permanent = False

permission_denied_message = ''

permission_required = None

post(request: HttpRequest, *args: Any, **kwargs: Any) → HttpResponse

Function to restore multiple organizations at once

Parameters:

• request (HttpRequest) – The current request

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Returns:

The redirect

Return type:

HttpResponse

prefetch_public_translations: bool = False

Whether the public translation objects should be prefetched

prefetch_translations: bool = False

Whether the translation objects should be prefetched

put(request, *args, **kwargs)

query_string = False

queryset = None

raise_exception = False

redirect_field_name = 'next'

require_change_permission: bool = True

Whether the view requires change permissions

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

url = None

view_is_async = False

Organization Content Mixin

class integreat_cms.cms.views.organizations.organization_content_mixin.OrganizationContextMixin

Bases: ContextMixin

This mixin provides extra context for organization views

__init__()

extra_context = None

get_context_data(**kwargs: Any) → dict[str, Any]

Returns a dictionary representing the template context (see get_context_data()).

Parameters:

**kwargs (Any) – The given keyword arguments

Returns:

The template context

Return type:

dict[str, Any]

Organization Form View

class integreat_cms.cms.views.organizations.organization_form_view.OrganizationFormView(**kwargs)

Bases: TemplateView, OrganizationContextMixin, MediaContextMixin

Class for rendering the organizations form

__init__(**kwargs)

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

classmethod as_view(**initkwargs)

Main entry point for a request-response process.

content_type = None

dispatch(request, *args, **kwargs)

extra_context = None

get(request: HttpRequest, *args: Any, **kwargs: Any) → HttpResponse

Render organization form for HTTP GET requests

Parameters:

• request (HttpRequest) – Object representing the user call

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Returns:

The rendered template response

Return type:

HttpResponse

get_context_data(**kwargs: Any) → dict[str, Any]

Returns a dictionary representing the template context (see get_context_data()).

Parameters:

**kwargs (Any) – The given keyword arguments

Returns:

The template context

Return type:

dict[str, Any]

get_template_names()

Return a list of template names to be used for the request. Must return a list. May not be called if render_to_response() is overridden.

http_method_names = ['get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace']

http_method_not_allowed(request, *args, **kwargs)

options(request, *args, **kwargs)

Handle responding to requests for the OPTIONS HTTP verb.

post(request: HttpRequest, **kwargs: Any) → HttpResponse

Save organization form for HTTP POST requests

Parameters:

• request (HttpRequest) – Object representing the user call

• **kwargs (Any) – The supplied keyword arguments

Returns:

The rendered template response

Return type:

HttpResponse

render_to_response(context, **response_kwargs)

Return a response, using the response_class for this view, with a template rendered with the given context.

Pass response_kwargs to the constructor of the response class.

response_class

alias of TemplateResponse

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

template_engine = None

template_name = 'organizations/organization_form.html'

The template to render (see TemplateResponseMixin)

view_is_async = False

Organization List View

class integreat_cms.cms.views.organizations.organization_list_view.OrganizationListView(**kwargs)

Bases: TemplateView, OrganizationContextMixin

View for listing organizations (either non-archived or archived organizations depending on archived)

__init__(**kwargs)

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

archived = False

Whether or not to show archived organizations

classmethod as_view(**initkwargs)

Main entry point for a request-response process.

content_type = None

dispatch(request, *args, **kwargs)

extra_context = None

get(request: HttpRequest, *args: Any, **kwargs: Any) → HttpResponse

Render organizations list for HTTP GET requests

Parameters:

• request (HttpRequest) – Object representing the user call

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Returns:

The rendered template response

Return type:

HttpResponse

get_context_data(**kwargs: Any) → dict[str, Any]

Returns a dictionary representing the template context (see get_context_data()).

Parameters:

**kwargs (Any) – The given keyword arguments

Returns:

The template context

Return type:

dict[str, Any]

get_template_names()

Return a list of template names to be used for the request. Must return a list. May not be called if render_to_response() is overridden.

http_method_names = ['get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace']

http_method_not_allowed(request, *args, **kwargs)

options(request, *args, **kwargs)

Handle responding to requests for the OPTIONS HTTP verb.

post(request: HttpRequest, *args: Any, **kwargs: Any) → HttpResponse

Apply the query and filter the rendered organizations

Parameters:

• request (HttpRequest) – The current request

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Returns:

The rendered template response

Return type:

HttpResponse

render_to_response(context, **response_kwargs)

Return a response, using the response_class for this view, with a template rendered with the given context.

Pass response_kwargs to the constructor of the response class.

response_class

alias of TemplateResponse

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

template_engine = None

template_name = 'organizations/organization_list.html'

Template for list of non-archived organizations

view_is_async = False