recordtransfer.enums - Enum classes for record transfer app

class recordtransfer.enums.SubmissionStep(*values)

Bases: Enum

Steps in the multi-stage submission form, listed in the order they should be completed. Note that the final step is either “uploadfiles” or “finalnotes” depending on the configuration.

ACCEPT_LEGAL = 'acceptlegal'

CONTACT_INFO = 'contactinfo'

SOURCE_INFO = 'sourceinfo'

RECORD_DESCRIPTION = 'recorddescription'

RIGHTS = 'rights'

OTHER_IDENTIFIERS = 'otheridentifiers'

GROUP_SUBMISSION = 'groupsubmission'

UPLOAD_FILES = 'uploadfiles'

FINAL_NOTES = 'finalnotes'

REVIEW = 'review'

class recordtransfer.enums.SiteSettingType(*values)

Bases: TextChoices

The type of the setting value.

INT = 'int'

STR = 'str'

class recordtransfer.enums.SettingKeyMeta(value_type: SiteSettingType, description: str, default_value: str | None = None)

Bases: NamedTuple

Describes a setting’s type, description, and default value.

value_type: SiteSettingType: Alias for field number 0

description: str: Alias for field number 1

default_value: str | None: Alias for field number 2

class recordtransfer.enums.SiteSettingKey(*values)

Bases: Enum

The keys for the site settings. These keys are used to store and retrieve settings from the database.

ARCHIVIST_EMAIL = (SiteSettingType.STR, 'The email displayed for people to contact an archivist.', 'archivist@example.com')

DO_NOT_REPLY_USERNAME = (SiteSettingType.STR, 'A username for the application to send "do not reply" emails from. This username is combined with the site\'s base URL to create an email address. The URL can be set from the admin site.', 'do-not-reply')

PAGINATE_BY = (SiteSettingType.INT, 'This setting controls how many rows of items are shown per page in tables that support pagination.', '10')

CAAIS_DEFAULT_REPOSITORY = (SiteSettingType.STR, 'Default value to fill in metadata for CAAIS sec. 1.1 - Repository.', None)

CAAIS_DEFAULT_ACCESSION_TITLE = (SiteSettingType.STR, 'Default value to fill in metadata for CAAIS sec. 1.3 - Accession Title', None)

CAAIS_DEFAULT_ARCHIVAL_UNIT = (SiteSettingType.STR, 'Default value to fill in metadata for CAAIS sec. 1.4 - Archival Unit.\nWhile the Archival Unit field is repeatable in CAAIS, it is not possible to specify multiple archival unit defaults.', None)

CAAIS_DEFAULT_DISPOSITION_AUTHORITY = (SiteSettingType.STR, 'Default value to fill in metadata for CAAIS sec. 1.6 - Disposition Authority.\nWhile the Disposition Authority field is repeatable, it is not possible to specify multiple disposition authority defaults.', None)

CAAIS_DEFAULT_ACQUISITION_METHOD = (SiteSettingType.STR, 'Default value to fill in metadata for CAAIS sec. 1.5 - Acquisition Method', None)

CAAIS_DEFAULT_STATUS = (SiteSettingType.STR, "Default value to fill in metadata for CAAIS sec. 1.7 - Status.\nLeave empty, or populate with a term like 'Waiting for review' to signify that the metadata has not been reviewed yet.", None)

CAAIS_DEFAULT_SOURCE_CONFIDENTIALITY = (SiteSettingType.STR, 'Default value to fill in metadata for CAAIS sec. 2.1.6 - Source Confidentiality.\nIf a default is supplied, the source confidentiality will be applied to every source of material received.', None)

CAAIS_DEFAULT_PRELIMINARY_CUSTODIAL_HISTORY = (SiteSettingType.STR, 'Default value to fill in metadata for CAAIS sec. 2.2 - Preliminary Custodial History.\nWhile the Preliminary Custodial History field is repeatable in CAAIS, it is not possible to specify multiple defaults here.', None)

CAAIS_DEFAULT_DATE_OF_MATERIALS = (SiteSettingType.STR, 'Default value to fill in metadata for CAAIS sec. 3.1 - Date of Materials', None)

CAAIS_DEFAULT_EXTENT_TYPE = (SiteSettingType.STR, 'Default value to fill in metadata for CAAIS sec. 3.2.1 - Extent Type.\nIf a default is supplied, the extent type will be applied to every extent statement received.', None)

CAAIS_DEFAULT_QUANTITY_AND_UNIT_OF_MEASURE = (SiteSettingType.STR, 'Default value to fill in metadata for CAAIS sec. 3.2.2 - Quantity and Unit of Measure.\nIf a default is supplied, the quantity and unit of measure will be applied to every extent statement received.', None)

CAAIS_DEFAULT_CONTENT_TYPE = (SiteSettingType.STR, 'Default value to fill in metadata for CAAIS sec. 3.2.3 - Content Type.\nIf a default is supplied, the content type will be applied to every extent statement received.', None)

CAAIS_DEFAULT_CARRIER_TYPE = (SiteSettingType.STR, 'Default value to fill in metadata for CAAIS sec. 3.2.4 - Carrier Type.\nIf a default is supplied, the carrier type will be applied to every extent statement received.', None)

CAAIS_DEFAULT_EXTENT_NOTE = (SiteSettingType.STR, 'Default value to fill in metadata for CAAIS sec. 3.2.5 - Extent Note.\nIf a default is supplied, the extent note will be applied to every extent statement received.', None)

CAAIS_DEFAULT_PRELIMINARY_SCOPE_AND_CONTENT = (SiteSettingType.STR, 'Default value to fill in metadata for CAAIS sec. 3.3 - Preliminary Scope and Content.\nWhile the Preliminary Scope and Content field is repeatable in CAAIS, it is not possible to specify multiple defaults here.', None)

CAAIS_DEFAULT_LANGUAGE_OF_MATERIAL = (SiteSettingType.STR, 'Default value to fill in metadata for CAAIS sec. 3.4 - Language of Material', None)

CAAIS_DEFAULT_STORAGE_LOCATION = (SiteSettingType.STR, 'Default value to fill in metadata for CAAIS sec. 4.1 - Storage Location', None)

CAAIS_DEFAULT_PRESERVATION_REQUIREMENTS_TYPE = (SiteSettingType.STR, 'Default value to fill in metadata for CAAIS sec. 4.3.1 - Preservation Requirements Type.\nIf not empty, a default preservation requirements statement will be applied to each submission.', None)

CAAIS_DEFAULT_PRESERVATION_REQUIREMENTS_VALUE = (SiteSettingType.STR, 'Default value to fill in metadata for CAAIS sec. 4.3.2 - Preservation Requirements Value.\nIf not empty, a default preservation requirements statement will be applied to each submission.', None)

CAAIS_DEFAULT_PRESERVATION_REQUIREMENTS_NOTE = (SiteSettingType.STR, 'Default value to fill in metadata for CAAIS sec. 4.3.3 - Preservation Requirements Note.\nIf not empty, a default preservation requirements statement will be applied to each submission.', None)

CAAIS_DEFAULT_APPRAISAL_TYPE = (SiteSettingType.STR, 'Default value to fill in metadata for CAAIS sec. 4.4.1 - Appraisal Type.\nIf not empty, a default appraisal statement will be applied to each submission.', None)

CAAIS_DEFAULT_APPRAISAL_VALUE = (SiteSettingType.STR, 'Default value to fill in metadata for CAAIS sec. 4.4.2 - Appraisal Value.\nIf not empty, a default appraisal statement will be applied to each submission.', None)

CAAIS_DEFAULT_APPRAISAL_NOTE = (SiteSettingType.STR, 'Default value to fill in metadata for CAAIS sec. 4.4.3 - Appraisal Note.\nIf not empty, a default appraisal statement will be applied to each submission.', None)

CAAIS_DEFAULT_ASSOCIATED_DOCUMENTATION_TYPE = (SiteSettingType.STR, 'Default value to fill in metadata for CAAIS sec. 4.5.1 - Associated Documentation Type.\nIf not empty, a default associated document will be applied to each submission.', None)

CAAIS_DEFAULT_ASSOCIATED_DOCUMENTATION_TITLE = (SiteSettingType.STR, 'Default value to fill in metadata for CAAIS sec. 4.5.2 - Associated Documentation Title.\nIf not empty, a default associated document will be applied to each submission.', None)

CAAIS_DEFAULT_ASSOCIATED_DOCUMENTATION_NOTE = (SiteSettingType.STR, 'Default value to fill in metadata for CAAIS sec. 4.5.3 - Associated Documentation Note.\nIf not empty, a default associated document will be applied to each submission.', None)

CAAIS_DEFAULT_GENERAL_NOTE = (SiteSettingType.STR, 'Default value to fill in metadata for CAAIS sec. 6.1 - General Note', None)

CAAIS_DEFAULT_RULES_OR_CONVENTIONS = (SiteSettingType.STR, 'Default value to fill in metadata for CAAIS sec. 7.1 - Rules or Conventions', None)

CAAIS_DEFAULT_LANGUAGE_OF_ACCESSION_RECORD = (SiteSettingType.STR, 'Default value to fill in metadata for CAAIS sec. 7.3 - Language of Accession Record', None)

CAAIS_DEFAULT_SUBMISSION_EVENT_TYPE = (SiteSettingType.STR, "Default submission event type name - related to CAAIS sec. 5.1.1.\nAt the time of receiving a submission, a 'Submission' type event is created for the submission. You can control the Event Type name for that event here.", 'Transfer Submitted')

CAAIS_DEFAULT_SUBMISSION_EVENT_AGENT = (SiteSettingType.STR, "Default submission event agent - related to CAAIS sec. 5.1.3.\nAt the time of receiving a submission, a 'Submission' type event is created for the submission. You can control the Event Agent's name for that event here.", None)

CAAIS_DEFAULT_SUBMISSION_EVENT_NOTE = (SiteSettingType.STR, "Default submission event note - related to CAAIS sec. 5.1.4.\nAt the time of receiving a submission, a 'Submission' type event is created for the submission. You can control whether an Event Note is added for the event here.", None)

CAAIS_DEFAULT_CREATION_TYPE = (SiteSettingType.STR, "Default date of creation event name - related to CAAIS sec. 7.2.1.\nAt the time of receiving a submission, a Date of Creation or Revision is created to indicate the date the accession record was created. You can control the name of the event here if you do not want to call it 'Creation'.", 'Creation')

CAAIS_DEFAULT_CREATION_AGENT = (SiteSettingType.STR, 'Default date of creation event agent - related to CAAIS sec. 7.2.3.\nAt the time of receiving a submission, a Date of Creation or Revision is created to indicate the date the accession record was created. You can control the name of the event agent here.', None)

CAAIS_DEFAULT_CREATION_NOTE = (SiteSettingType.STR, 'Default date of creation event note - related to CAAIS sec. 7.2.4.\nAt the time of receiving a submission, a Date of Creation or Revision is created to indicate the date the accession record was created. You can add a note to that event here by setting the value to something other than an empty string.', None)

property key_name: str: The name of the setting key, used for database storage.

property value_type: SiteSettingType: The type of the setting value.

property description: str: A description of the setting, used for display in the admin interface.

property default_value: str | None: The default value for the setting, used if no value is set in the database.