"""
    REST API Documentation for the NRS TFRS Credit Trading Application

    The Transportation Fuels Reporting System is being designed to streamline
    compliance reporting for transportation fuel suppliers in accordance with
    the Renewable & Low Carbon Fuel Requirements Regulation.

    OpenAPI spec version: v1

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
"""

from django.db import models

from api.managers.TheTypeManager import TheTypeManager
from api.models.mixins.DisplayOrder import DisplayOrder
from api.models.mixins.EffectiveDates import EffectiveDates
from auditable.models import Auditable


class OrganizationActionsType(Auditable, DisplayOrder, EffectiveDates):
    the_type = models.CharField(
        max_length=25,
        unique=True,
        db_comment="Enumerated value to describe the organization actions "
                   "type."
    )
    description = models.CharField(
        max_length=1000,
        blank=True,
        null=True,
        db_comment="Description of the organization actions type. This is the "
                   "displayed name."
    )

    objects = TheTypeManager()

    def natural_key(self):
        return (self.the_type,)

    class Meta:
        db_table = 'organization_actions_type'

    db_table_comment = "Contains a list of actions that each organization " \
                       "type is permitted to do. Example actions include a " \
                       "fuel supplier organization type being permitted to " \
                       "create a new Credit Transfer Proposal whereas a " \
                       "government organization type is permitted to create " \
                       "a new credit transaction. For example; Part 3 " \
                       "Award, Validation, or Reduction"
