caais.managers - Model managers for CAAIS models

class caais.managers.MetadataQuerySet(model=None, query=None, using=None, hints=None)

Bases: QuerySet

Custom queryset for Metadata objects that has an export_csv method to convert all objects to a CSV.

export_csv(version: ExportVersion = ExportVersion.CAAIS_1_0, filename_prefix: str | None = None) → HttpResponse

Create an HttpResponse that contains a CSV representation of all metadata objects in the queryset.

Parameters:

version – The type/version of the CSV to export
filename_prefix – Prefix for the generated CSV filename. If not provided, a default is used.

Returns:

An HTTP response to download the CSV.

class caais.managers.CaaisModelManager(*args, **kwargs)

Bases: Manager, ABC

Custom manager for CAAIS models that require the flatten() function.

abstract flatten_atom(version: ExportVersion) → dict: Flatten metadata to be used for AtoM.

abstract flatten_caais(version: ExportVersion) → dict: Flatten metadata to be used for CAAIS.

flatten(version: ExportVersion = ExportVersion.CAAIS_1_0) → dict: Flatten metadata to be used in BagIt metadata or CSV file.

class caais.managers.IdentifierManager(*args, **kwargs)

Bases: CaaisModelManager

Custom manager for Identifier model.

accession_identifier() → str | None: Get the first identifier with the ACCESSION_IDENTIFIER_TYPE type, or None if an identifier like this does not exist.

flatten_atom(version: ExportVersion) → dict: Flatten metadata to be used for AtoM.

flatten_caais(version: ExportVersion) → dict: Flatten metadata to be used for CAAIS.

class caais.managers.ArchivalUnitManager(*args, **kwargs)

Bases: CaaisModelManager

Custom manager for Archival Unit model.

flatten_atom(version: ExportVersion) → dict: Flatten metadata to be used for AtoM.

flatten_caais(version: ExportVersion) → dict: Flatten metadata to be used for CAAIS.

class caais.managers.DispositionAuthorityManager(*args, **kwargs)

Bases: CaaisModelManager

Custom manager for DispositionAuthority model.

flatten_atom(version: ExportVersion) → dict: Flatten metadata to be used for AtoM.

flatten_caais(version: ExportVersion) → dict: Flatten metadata to be used for CAAIS.

class caais.managers.SourceOfMaterialManager(*args, **kwargs)

Bases: CaaisModelManager

Custom manager for SourceOfMaterial model.

flatten_atom(version: ExportVersion) → dict: Flatten metadata to be used for AtoM.

flatten_caais(version: ExportVersion) → dict: Flatten metadata to be used for CAAIS.

class caais.managers.PreliminaryCustodialHistoryManager(*args, **kwargs)

Bases: CaaisModelManager

Custom manager for PreliminaryCustodialHistory model.

flatten_atom(version: ExportVersion) → dict: Include single custodial history if there is only one, otherwise create a bullet point list of all received extents.

flatten_caais(version: ExportVersion) → dict: Flatten metadata to be used for CAAIS.

class caais.managers.ExtentStatementManager(*args, **kwargs)

Bases: CaaisModelManager

Custom manager for ExtentStatement model.

flatten_atom(version: ExportVersion) → dict: Include single extent if there is only one, otherwise create a bullet point list of all received extents.

flatten_caais(version: ExportVersion) → dict: Flatten metadata to be used for CAAIS.

class caais.managers.PreliminaryScopeAndContentManager(*args, **kwargs)

Bases: CaaisModelManager

Custom manager for PreliminaryScopeAndContent model.

flatten_atom(version: ExportVersion) → dict: Flatten metadata to be used for AtoM.

flatten_caais(version: ExportVersion) → dict: Flatten metadata to be used for CAAIS.

class caais.managers.LanguageOfMaterialManager(*args, **kwargs)

Bases: CaaisModelManager

Custom manager for LanguageOfMaterial model.

flatten_atom(version: ExportVersion) → dict: Flatten metadata to be used for AtoM.

flatten_caais(version: ExportVersion) → dict: Flatten metadata to be used for CAAIS.

class caais.managers.StorageLocationManager(*args, **kwargs)

Bases: CaaisModelManager

Custom manager for StorageLocation model.

flatten_atom(version: ExportVersion) → dict: Include single location if there is only one, otherwise create a bullet point list of all location values.

flatten_caais(version: ExportVersion) → dict: Flatten metadata to be used for CAAIS.

class caais.managers.RightsManager(*args, **kwargs)

Bases: CaaisModelManager

Custom manager for Rights model.

flatten_atom(version: ExportVersion) → dict: Flatten metadata to be used for AtoM.

flatten_caais(version: ExportVersion) → dict: Flatten metadata to be used for CAAIS.

caais.managers.build_value_note(value: str, note: str) → str: Create a combined value + note string for display.

class caais.managers.PreservationRequirementsManager(*args, **kwargs)

Bases: CaaisModelManager

Custom manager for PreservationRequirements model.

flatten_atom(version: ExportVersion) → dict: Include first value + note if there is only one, otherwise include every value + note in a bullet point list.

flatten_caais(version: ExportVersion) → dict: Flatten metadata to be used for CAAIS.

class caais.managers.AppraisalManager(*args, **kwargs)

Bases: CaaisModelManager

Custom manager for Appraisal model.

flatten_atom(version: ExportVersion) → dict: Include single appraisal value + note if there is only one, otherwise create a bullet point list of all appraisals’ value + note.

flatten_caais(version: ExportVersion) → dict: Flatten metadata to be used for CAAIS.

class caais.managers.AssociatedDocumentationManager(*args, **kwargs)

Bases: CaaisModelManager

Custom manager for AssociatedDocumentation model.

flatten_atom(version: ExportVersion) → dict: Flatten metadata to be used for AtoM.

flatten_caais(version: ExportVersion) → dict: Flatten metadata to be used for CAAIS.

class caais.managers.EventManager(*args, **kwargs)

Bases: CaaisModelManager

Custom manager for Event model.

get_queryset() → QuerySet: Return the queryset for events.

flatten_atom(version: ExportVersion) → dict: Flatten metadata to be used for AtoM.

flatten_caais(version: ExportVersion) → dict: Flatten metadata to be used for CAAIS.

class caais.managers.GeneralNoteManager(*args, **kwargs)

Bases: CaaisModelManager

Custom manager for GeneralNote model.

flatten_atom(version: ExportVersion) → dict: Flatten metadata to be used for AtoM.

flatten_caais(version: ExportVersion) → dict: Flatten metadata to be used for CAAIS.

class caais.managers.DateOfCreationOrRevisionManager(*args, **kwargs)

Bases: CaaisModelManager

Custom manager for DateOfCreationOrRevision model.

get_queryset() → QuerySet: Return the queryset for dates of creation or revision.

flatten_atom(version: ExportVersion) → dict: Flatten metadata to be used for AtoM.

flatten_caais(version: ExportVersion) → dict: Flatten metadata to be used for CAAIS.