DOKUMENT modely

Definice modelů.

Třídy

class Dokument

Databázový model dokumentu.

Metody:

__init__()

Inicializuje instanci třídy.

Parametry:

• args – Parametr args se předává do volání __init__().

• kwargs – Parametr kwargs se předává do volání __init__().

__str__()

Vrací textovou reprezentaci objektu.

Textová reprezentace objektu.

Vrací:

Vrací atribut objektu.

get_absolute_url()

Metoda pro získaní absolut url záznamu podle typu dokumentu.

Vrací:

Vrací výsledek volání reverse().

set_doi()

Nastaví doi. v aplikaci.

set_zapsany()

Metoda pro nastavení stavu zapsaný a uložení změny do historie.

Parametry:

user – Parametr user se předává do volání Historie().

set_permanent_identificator()

Nastaví permanent identificator.

Parametry:

• dokument – Parametr dokument předává se do volání get_dokument_rada(), set_permanent_ident_cely(), pracuje se s atributy ident_cely, typ_dokumentu.

• request – Parametr request předává se do volání add_message().

• messages – Parametr messages předává se do volání add_message(), pracuje se s atributy add_message, SUCCESS.

• fedora_transaction – Parametr fedora_transaction pracuje se s atributy rollback_transaction.

Výsledek provedené změny nad cílovým objektem.

Vrací:

Vrací hodnotu typu Optional[JsonResponse] (výsledek volání JsonResponse()).

set_odeslany()

Metoda pro nastavení stavu odeslaný a uložení změny do historie.

Parametry:

• user – Parametr user se předává do volání Historie().

• old_ident – Identifikátor old_ident používaný pro dohledání cílového záznamu.

set_archivovany()

Metoda pro nastavení stavu archivovaný a uložení změny do historie.

Parametry:

• user – Parametr user se předává do volání Historie().

• old_ident – Identifikátor old_ident používaný pro dohledání cílového záznamu.

set_vraceny()

Metoda pro vrácení o jeden stav méně a uložení změny do historie.

Parametry:

• user – Parametr user se předává do volání Historie().

• new_state – Stavová nebo časová hodnota new_state používaná při rozhodování logiky.

• poznamka – Parametr poznamka se předává do volání Historie().

check_pred_odeslanim()

Metoda na kontrolu prerekvizit pred posunem do stavu odeslaný:

polia: format, popis, duveryhodnost, obdobi, areal jsou vyplněna pro model 3D.

polia: pristupnost, popis, ulozeni_originalu jsou vyplněna pro model 3D.

Dokument má aspoň jeden dokument.

Vrací:

Vrací proměnná result.

check_pred_archivaci()

Metoda na kontrolu prerekvizit pred archivací:

kontrola jako před odesláním

Vrací:

Vrací proměnná result.

has_extra_data()

Metoda na zjištení že dokument má extra data.

Vrací:

Vrací proměnná has_extra_data.

get_komponenta()

Metoda na získaní všech komponent dokumentu.

Vrací:

Vrací hodnotu podle větve zpracování, typicky: vybranou hodnotu z kolekce, None.

Vyvolá:

UnexpectedDataRelations – Vyvolá se s textem „Neleze ziskat komponentu modelu 3D.“.

set_permanent_ident_cely()

Metoda pro nastavení permanentního ident celý pro dokument.

Metoda bere pořadoví číslo z db dokument sekvence. Metoda zmení i ident připojených souborů.

Parametry:

• region – Parametr region se předává do volání get(), create().

• rada – Parametr rada se předává do volání get(), create(), pracuje se s atributy zkratka.

Vyvolá:

MaximalIdentNumberError – Vyvolá se při splnění podmínky sequence.sekvence >= MAXIMUM; nebo při splnění podmínky missing[0] >= MAXIMUM.

set_datum_zverejneni()

metoda pro nastavení datumu zvěřejnení.

get_permission_object()

Vrací permission object.

Vrací:

Vrací proměnná self.

get_create_user()

Vrací create user.

Vrací:

Vrací n-tici.

get_create_org()

Vrací create org.

Vrací:

Vrací n-tici.

thumbnail_image()

Provádí operaci thumbnail image.

Vrací:

Vrací atribut objektu.

thumbnail_image_file()

Provádí operaci thumbnail image file.

Vrací:

Výstup funkce odpovídající implementované logice.

large_thumbnail()

Provádí operaci large thumbnail.

Vrací:

Vrací hodnotu podle větve zpracování, typicky: atribut objektu, None.

small_thumbnail()

Provádí operaci small thumbnail.

Vrací:

Vrací hodnotu podle větve zpracování, typicky: atribut objektu, None.

set_snapshots()

Nastaví snapshots. v aplikaci.

redis_snapshot_id()

Provádí operaci redis snapshot id.

Vrací:

Vrací hodnotu podle větve zpracování.

generate_redis_snapshot()

Vygeneruje redis snapshot.

Vrací:

Vrací n-tici.

_get_doi_client()

Vrací doi client.

Vrací:

Načtená data odpovídající zadaným vstupům.

doi_exists()

Provádí operaci doi exists.

Vrací:

Vrací výsledek volání check_record_exists().

doi_delete()

Provádí operaci doi delete.

Parametry:

check_status – Parametr check_status předává se do volání delete_record(), vstupuje do návratové hodnoty.

Vrací:

Vrací výsledek volání delete_record().

doi_hide()

Provádí operaci doi hide.

Parametry:

check_status – Parametr check_status předává se do volání hide_record(), vstupuje do návratové hodnoty.

Vrací:

Vrací výsledek volání hide_record().

doi_publish()

Provádí operaci doi publish.

Parametry:

check_status – Parametr check_status předává se do volání publish_record(), vstupuje do návratové hodnoty.

Vrací:

Vrací výsledek volání publish_record().

doi_update()

Provádí operaci doi update.

Parametry:

• check_status – Parametr check_status předává se do volání update_record(), vstupuje do návratové hodnoty.

• reload_record – Parametr reload_record předává se do volání update_record(), vstupuje do návratové hodnoty.

Vrací:

Vrací výsledek volání update_record().

doi_url()

Provádí operaci doi url.

Vrací:

Vrací výsledek volání get_record_url().

class DokumentCast

Databázový model části dokumentu.

Metody:

get_absolute_url()

Metoda pro získaní absolut url.

Vrací:

Vrací hodnotu podle větve zpracování, typicky: výsledek volání get_absolute_url(), výsledek volání reverse().

get_permission_object()

Vrací permission object.

Vrací:

Vrací výsledek volání get_permission_object().

__init__()

Inicializuje instanci třídy.

Parametry:

• args – Parametr args se předává do volání __init__().

• kwargs – Parametr kwargs se předává do volání __init__().

initial_archeologicky_zaznam()

Vrátí objekt dokument na základě initial_archeologicky_zaznam_id (líné načtení).

Vrací:

Vrací výsledek operace.

initial_projekt()

Provádí operaci initial projekt.

Vrací:

Výstup funkce odpovídající implementované logice.

create_transaction()

Vytvoří transaction. v aplikaci.

Parametry:

• transaction_user – Uživatel nebo osoba transaction_user, v jejímž kontextu se operace provádí.

• success_message – Parametr success_message předává se do volání FedoraTransaction().

• error_message – Parametr error_message předává se do volání FedoraTransaction().

Vrací:

Vrací atribut objektu.

dokument_doi()

Provádí operaci dokument doi.

Vrací:

Vrací atribut objektu.

class DokumentExtraData

Databázový model doplňkových dat dokumentu.

class DokumentAutor

Databázový model autorů dokumentu (včetně pořadí).

class DokumentJazyk

Databázový model jazyků dokumentu.

Metody:

__str__()

Vrací textovou reprezentaci objektu.

Textová reprezentace objektu.

Vrací:

Vrací hodnotu podle větve zpracování.

class DokumentOsoba

Databázový model osob dokumentu.

class DokumentPosudek

Databázový model posudků dokumentu.

Metody:

__str__()

Vrací textovou reprezentaci objektu.

Textová reprezentace objektu.

Vrací:

Vrací hodnotu podle větve zpracování.

class Tvar

Databázový model tvarů.

Metody:

__init__()

Inicializuje instanci třídy.

Parametry:

• args – Parametr args se předává do volání __init__().

• kwargs – Parametr kwargs se předává do volání __init__().

create_transaction()

Vytvoří transaction. v aplikaci.

Parametry:

• transaction_user – Uživatel nebo osoba transaction_user, v jejímž kontextu se operace provádí.

• success_message – Parametr success_message předává se do volání FedoraTransaction().

• error_message – Parametr error_message předává se do volání FedoraTransaction().

Vrací:

Vrací atribut objektu.

class DokumentSekvence

Databázový model sekvence dokumentu podle roku a řady.

class Let

Databázový model letu.

Metody:

__str__()

Vrací textovou reprezentaci objektu.

Textová reprezentace objektu.

Vrací:

Vrací atribut objektu.

save()

Uloží změny objektu.

Parametry:

• args – Parametr args se předává do volání save().

• kwargs – Parametr kwargs se předává do volání save().

Vyvolá:

ValidationError – Vyvolá se při splnění podmínky not self._state.adding or FedoraRepositoryConnector.check_container_deleted_or_not_exists(self.ident_cely, 'let').

get_absolute_url()

Vrací absolute url.

Vrací:

Vrací výsledek volání reverse().

Funkce

get_dokument_soubor_name(dokument, filename, add_to_index)

Funkce pro získaní správného jména souboru.

Parametry:

• dokument – Parametr dokument předává se do volání debug(), filter(), pracuje se s atributy ident_cely, soubory, vstupuje do návratové hodnoty.

• filename – Parametr filename se předává do volání splitext(), vstupuje do návratové hodnoty.

• add_to_index – Číselná hodnota add_to_index použitá při výpočtu nebo transformaci.

Vrací:

Vrací hodnotu podle větve zpracování, typicky: hodnotu podle větve zpracování, bool.