Package info.oais.interfaces.infomodel

Interface ArchivalInformationPackage

All Superinterfaces:

DataObject, InformationPackage

All Known Subinterfaces:

ArchivalInformationCollection, ArchivalInformationUnit

All Known Implementing Classes:

ArchivalInformationPackageImpl1, ArchivalInformationUnitImpl1

public interface ArchivalInformationPackage
extends InformationPackage

An Information Package, consisting of the Content Information and the associated Preservation Description Information (PDI), which is preserved within an OAIS. [OAIS]

NOTE: The get/set "isDeclaredComplete" has been added because otherwise there is no way to be sure whether an AIP is ready i.e. has everything needed for preservation. It should be set as true when the construction of the AIP is considered to finished.

Since:

06-Sep-2021 15:59:45

Version:

1.0

Author:

David

Method Summary

Modifier and Type	Method	Description
ContentInformation	getContentInformation()	Get the ContentInformation in the AIP.
PreservationDescriptionInformation	getPDI()	Get the ProvenanceDescriptionInformation in the AIP.
boolean	isDeclaredComplete()	If an archive declares that the AIP is complete i.e.
void	setContentInformation(ContentInformation ci)
void	setIsDeclaredComplete(boolean complete)	Set whether the AIP is complete.
void	setPDI(PreservationDescriptionInformation pdi)

Methods inherited from interface info.oais.interfaces.infomodel.DataObject

getDigitalObject, getPhysicalObject, setDigitalObject, setPhysicalObject

Methods inherited from interface info.oais.interfaces.infomodel.InformationPackage

getIdentifier, getInformationObject, getPackageDescription, getPackagingInformation, setIdentifier, setInformationObject, setPackageDescription, setPackagingInformation

Method Details

isDeclaredComplete

boolean isDeclaredComplete()

If an archive declares that the AIP is complete i.e. is suitable for long term preservation in that archive, then this method should return TRUE.

Returns:

A boolean which if true declares that the AIP is complete, otherwise it is incomplete.

setIsDeclaredComplete

void setIsDeclaredComplete(boolean complete)

Set whether the AIP is complete.

Parameters:

complete - If true then this declares that the AIP is complete i.e. has all the components needed for the preservation of the InformationObject which is the target of preservation.

getPDI

PreservationDescriptionInformation getPDI()

Get the ProvenanceDescriptionInformation in the AIP.

Returns:

The ProvenanceDescriptionInformation in the AIP

setPDI

void setPDI(PreservationDescriptionInformation pdi)

Parameters:

pdi - The ProvenanceDescriptionInformation to be in the AIP

getContentInformation

ContentInformation getContentInformation()

Get the ContentInformation in the AIP.

Returns:

The ContentInformation in the AIP

setContentInformation

void setContentInformation(ContentInformation ci)

Parameters:

ci - The ContentInformation to be in the AIP