Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
TerraNexus 2025-06-27.2 documentation
Light Logo Dark Logo
TerraNexus 2025-06-27.2 documentation

Contents:

  • TerraNexus Third Party Software Dependencies
  • TerraNexus Client
    • TerraNexus DGGS Operations Interface
      • DGGS Generation
      • TerraNexus DGGS Tools Interface
        • Surface DGGS Tools
        • Volumetric DGGS Tools
        • DGGS Job Status
      • OGC API Client Interface
    • TerraNexus Client Visualisation Tools
      • TerraNexus Client - Background Visualisation Configuration
      • TerraNexus Client - DGGS Zone Visualisation Configuration
  • TerraNexus OGC API Web Interface
  • TerraNexus API Reference
    • TerraNexus API
      • TerraNexus Web Application Package
      • Home Page Package
      • OGC API Package
      • Surface DGGS Package
        • Surface DGGS Scripts Package
      • Volumetric DGGS Package
        • Volumetric DGGS Scripts Package
      • Database Viewer Package
      • TerraNexus Utilities Package
      • User Account Package
      • User Signup Package
      • Legal Package
    • Kubernetes Utility Modules
  • Deployment Scripts
    • Google Kubernetes Engine (GKE) Deployment
      • deploy.gke.gke_terranexus_app_deploy module
      • deploy.gke.gke_terranexus_app_teardown module
      • deploy.gke.gke_terranexus_build_container module
      • deploy.gke.gke_terranexus_deploy_cluster module
      • deploy.gke.gke_terranexus_mongodb_cluster_init module
      • deploy.gke.gke_terranexus_mongodb_cluster_init_singlenode module
      • deploy.gke.gke_terranexus_restart_mongodb_cluster module
      • deploy.gke.gke_terranexus_teardown_cluster module
    • Minikube Deployment
      • deploy.minikube.install_minikube module
      • deploy.minikube.minikube_terranexus_app_deploy module
      • deploy.minikube.minikube_terranexus_app_teardown module
      • deploy.minikube.minikube_terranexus_cluster_deploy module
      • deploy.minikube.minikube_terranexus_cluster_restart module
      • deploy.minikube.minikube_terranexus_mongodb_cluster_init module
      • deploy.minikube.minikube_terranexus_restart_mongodb_cluster module
  • References
  • Glossary
Back to top
View this page

Legal Package¶

The legal package contains the modules necessary to support the publication of legal disclaimers, user licencing and copyright information about the TerraNexus Web Application

Legal Submodules¶

The following submodules are defined by this package.

legal.admin module¶

Note

Module Details

Legal Package “admin” module

This module defines parameters and configuration for the site administration of the TerraNexus Legal Package.

Created: 7 September 2017

@author: Dr. Matthew B.J. Purss

class legal.admin.CopyrightAdmin(model, admin_site)¶

Bases: ModelAdmin

Note

Class Details

Copyright Administration Class.

exclude = ['id']¶
fieldsets = [(None, {'fields': ['legal_statement']}), (None, {'fields': ['show_record']}), ('Date information', {'classes': ['collapse'], 'fields': ['date_published']})]¶
list_display = ['record_id', 'legal_statement', 'show_record', 'date_published']¶
list_filter = ['date_published']¶
property media¶
search_fields = ['record_id', 'legal_statement']¶
class legal.admin.DisclaimerAdmin(model, admin_site)¶

Bases: ModelAdmin

Note

Class Details

Disclaimer Administration Class.

fieldsets = [(None, {'fields': ['legal_statement']}), (None, {'fields': ['show_record']}), ('Date information', {'classes': ['collapse'], 'fields': ['date_published']})]¶
list_display = ['record_id', 'legal_statement', 'show_record', 'date_published']¶
list_filter = ['date_published']¶
property media¶
search_fields = ['record_id', 'legal_statement']¶
class legal.admin.PrivacyAdmin(model, admin_site)¶

Bases: ModelAdmin

Note

Class Details

Privacy Notice Administration Class.

fieldsets = [(None, {'fields': ['legal_statement']}), (None, {'fields': ['show_record']}), ('Date information', {'classes': ['collapse'], 'fields': ['date_published']})]¶
list_display = ['record_id', 'legal_statement', 'show_record', 'date_published']¶
list_filter = ['date_published']¶
property media¶
search_fields = ['record_id', 'legal_statement']¶
class legal.admin.Terms_and_ConditionsAdmin(model, admin_site)¶

Bases: ModelAdmin

Note

Class Details

Terms and Conditions Notice Administration Class.

fieldsets = [(None, {'fields': ['legal_statement']}), (None, {'fields': ['show_record']}), ('Date information', {'classes': ['collapse'], 'fields': ['date_published']})]¶
list_display = ['record_id', 'legal_statement', 'show_record', 'date_published']¶
list_filter = ['date_published']¶
property media¶
search_fields = ['record_id', 'legal_statement']¶

legal.apps module¶

Note

Module Details

Legal Package Application Registration module

This Class module is required to register each Django package under the main web application.

Created: 7 September 2017

@author: Dr. Matthew B.J. Purss

class legal.apps.LegalConfig(app_name, app_module)¶

Bases: AppConfig

name = 'legal'¶

legal.models module¶

Note

Module Details

Legal Package Model Definition Resource

This Class module is required to configure the base “model” that supports the TerraNexus Legal declarations.

This is part of the Model View Controller (MVC) Architecture that underpins Django web applications.

For operational and security reasons the conventional “model” structure supported as standard by Django has been replaced with a mongodb version of this architecture.

This also enables management of the TerraNexus administration database in the same context as all other TerraNexus databases.

Created: 7 September 2017

@author: Dr. Matthew B.J. Purss

class legal.models.Copyright(*args, **kwargs)¶

Bases: Model

Note

Class Details

Copyright Declaration Class definition.

Parameters:
  • id (int) – The database “id” field value.

  • legal_statement (string) – copyright legal statement.

  • date_published (dateTime-Object) – The date of publication of the legal statement.

  • show_record (boolean) – Flag to indicate whether or not the copyright statement should be visible.

  • record_id (string) – The record identifier.

exception DoesNotExist¶

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned¶

Bases: MultipleObjectsReturned

clean()¶

Hook for doing any extra model-wide validation after clean() has been called on every field by self.clean_fields. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field defined by NON_FIELD_ERRORS.

date_published¶

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_next_by_date_published(*, field=<django.db.models.fields.DateTimeField: date_published>, is_next=True, **kwargs)¶
get_previous_by_date_published(*, field=<django.db.models.fields.DateTimeField: date_published>, is_next=False, **kwargs)¶
id¶

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

legal_statement¶

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>¶
record_id¶

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

save(*args, **kwargs)¶

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

show_record¶

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class legal.models.Disclaimer(*args, **kwargs)¶

Bases: Model

Note

Function Details

Disclaimer Declaration Class definition.

Parameters:
  • id (int) – The database “id” field value.

  • legal_statement (string) – copyright legal statement.

  • date_published (dateTime-Object) – The date of publication of the legal statement.

  • show_record (boolean) – Flag to indicate whether or not the copyright statement should be visible.

  • record_id (string) – The record identifier.

exception DoesNotExist¶

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned¶

Bases: MultipleObjectsReturned

clean()¶

Hook for doing any extra model-wide validation after clean() has been called on every field by self.clean_fields. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field defined by NON_FIELD_ERRORS.

date_published¶

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_next_by_date_published(*, field=<django.db.models.fields.DateTimeField: date_published>, is_next=True, **kwargs)¶
get_previous_by_date_published(*, field=<django.db.models.fields.DateTimeField: date_published>, is_next=False, **kwargs)¶
id¶

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

legal_statement¶

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>¶
record_id¶

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

save(*args, **kwargs)¶

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

show_record¶

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class legal.models.Privacy(*args, **kwargs)¶

Bases: Model

Note

Function Details

Privacy Declaration Class definition.

Parameters:
  • id (int) – The database “id” field value.

  • legal_statement (string) – copyright legal statement.

  • date_published (dateTime-Object) – The date of publication of the legal statement.

  • show_record (boolean) – Flag to indicate whether or not the copyright statement should be visible.

  • record_id (string) – The record identifier.

exception DoesNotExist¶

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned¶

Bases: MultipleObjectsReturned

clean()¶

Hook for doing any extra model-wide validation after clean() has been called on every field by self.clean_fields. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field defined by NON_FIELD_ERRORS.

date_published¶

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_next_by_date_published(*, field=<django.db.models.fields.DateTimeField: date_published>, is_next=True, **kwargs)¶
get_previous_by_date_published(*, field=<django.db.models.fields.DateTimeField: date_published>, is_next=False, **kwargs)¶
id¶

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

legal_statement¶

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>¶
record_id¶

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

save(*args, **kwargs)¶

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

show_record¶

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class legal.models.Terms_and_Conditions(*args, **kwargs)¶

Bases: Model

Note

Function Details

Terms and Conditions Declaration Class definition.

Parameters:
  • id (int) – The database “id” field value.

  • legal_statement (string) – copyright legal statement.

  • date_published (dateTime-Object) – The date of publication of the legal statement.

  • show_record (boolean) – Flag to indicate whether or not the copyright statement should be visible.

  • record_id (string) – The record identifier.

exception DoesNotExist¶

Bases: ObjectDoesNotExist

exception MultipleObjectsReturned¶

Bases: MultipleObjectsReturned

clean()¶

Hook for doing any extra model-wide validation after clean() has been called on every field by self.clean_fields. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field defined by NON_FIELD_ERRORS.

date_published¶

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_next_by_date_published(*, field=<django.db.models.fields.DateTimeField: date_published>, is_next=True, **kwargs)¶
get_previous_by_date_published(*, field=<django.db.models.fields.DateTimeField: date_published>, is_next=False, **kwargs)¶
id¶

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

legal_statement¶

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>¶
record_id¶

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

save(*args, **kwargs)¶

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

show_record¶

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

legal.tests module¶

legal.urls module¶

Note

Module Details

legal URL Configuration

The urlpatterns list routes URLs to views for the legal package. For more information please see: Django Documentation - urls

Created: 7 September 2017

@author: Dr. Matthew B.J. Purss

legal.views module¶

Note

Module Details

Legal “Views” module

This module prepares the views necessary to perform all tasks relevant to the TerraNexus legal package.

Created: 7 September 2017

@author: Dr. Matthew B.J. Purss

legal.views.legal_statements(request)¶

Note

Function Details

legal_statements Page

Parameters:

request (request-object) – The html request object.

Next
Kubernetes Utility Modules
Previous
User Signup Package
Copyright © 2023, Pangaea Innovations Pty. Ltd.
Made with Sphinx and @pradyunsg's Furo
On this page
  • Legal Package
    • Legal Submodules
      • legal.admin module
        • CopyrightAdmin
          • CopyrightAdmin.exclude
          • CopyrightAdmin.fieldsets
          • CopyrightAdmin.list_display
          • CopyrightAdmin.list_filter
          • CopyrightAdmin.media
          • CopyrightAdmin.search_fields
        • DisclaimerAdmin
          • DisclaimerAdmin.fieldsets
          • DisclaimerAdmin.list_display
          • DisclaimerAdmin.list_filter
          • DisclaimerAdmin.media
          • DisclaimerAdmin.search_fields
        • PrivacyAdmin
          • PrivacyAdmin.fieldsets
          • PrivacyAdmin.list_display
          • PrivacyAdmin.list_filter
          • PrivacyAdmin.media
          • PrivacyAdmin.search_fields
        • Terms_and_ConditionsAdmin
          • Terms_and_ConditionsAdmin.fieldsets
          • Terms_and_ConditionsAdmin.list_display
          • Terms_and_ConditionsAdmin.list_filter
          • Terms_and_ConditionsAdmin.media
          • Terms_and_ConditionsAdmin.search_fields
      • legal.apps module
        • LegalConfig
          • LegalConfig.name
      • legal.models module
        • Copyright
          • Copyright.DoesNotExist
          • Copyright.MultipleObjectsReturned
          • Copyright.clean()
          • Copyright.date_published
          • Copyright.get_next_by_date_published()
          • Copyright.get_previous_by_date_published()
          • Copyright.id
          • Copyright.legal_statement
          • Copyright.objects
          • Copyright.record_id
          • Copyright.save()
          • Copyright.show_record
        • Disclaimer
          • Disclaimer.DoesNotExist
          • Disclaimer.MultipleObjectsReturned
          • Disclaimer.clean()
          • Disclaimer.date_published
          • Disclaimer.get_next_by_date_published()
          • Disclaimer.get_previous_by_date_published()
          • Disclaimer.id
          • Disclaimer.legal_statement
          • Disclaimer.objects
          • Disclaimer.record_id
          • Disclaimer.save()
          • Disclaimer.show_record
        • Privacy
          • Privacy.DoesNotExist
          • Privacy.MultipleObjectsReturned
          • Privacy.clean()
          • Privacy.date_published
          • Privacy.get_next_by_date_published()
          • Privacy.get_previous_by_date_published()
          • Privacy.id
          • Privacy.legal_statement
          • Privacy.objects
          • Privacy.record_id
          • Privacy.save()
          • Privacy.show_record
        • Terms_and_Conditions
          • Terms_and_Conditions.DoesNotExist
          • Terms_and_Conditions.MultipleObjectsReturned
          • Terms_and_Conditions.clean()
          • Terms_and_Conditions.date_published
          • Terms_and_Conditions.get_next_by_date_published()
          • Terms_and_Conditions.get_previous_by_date_published()
          • Terms_and_Conditions.id
          • Terms_and_Conditions.legal_statement
          • Terms_and_Conditions.objects
          • Terms_and_Conditions.record_id
          • Terms_and_Conditions.save()
          • Terms_and_Conditions.show_record
      • legal.tests module
      • legal.urls module
      • legal.views module
        • legal_statements()