Class IngestContract

  • All Implemented Interfaces:
    java.io.Serializable, java.util.Map<java.lang.String,​java.lang.Object>, org.bson.conversions.Bson

    public class IngestContract
    extends VitamDocument<IngestContract>
    Defines an Ingest contract model for SIP transfer control.
    It's an implementation of the SEDA specification and NF Z44022 MEDONA concerning the communication between a TransferringAgency and an ArchivalAgency.
    See Also:
    Serialized Form
    • Field Detail

      • IDENTIFIER

        public static final java.lang.String IDENTIFIER
        the contract id
        See Also:
        Constant Field Values
      • DESCRIPTION

        public static final java.lang.String DESCRIPTION
        the contract description
        See Also:
        Constant Field Values
      • STATUS

        public static final java.lang.String STATUS
        the contract status
        See Also:
        Constant Field Values
      • CHECKPARENTLINK

        public static final java.lang.String CHECKPARENTLINK
        check parent link status (ACTIVE / INACTIVE)
        See Also:
        Constant Field Values
      • ARCHIVEPROFILES

        public static final java.lang.String ARCHIVEPROFILES
        Archive profile
        See Also:
        Constant Field Values
      • CREATIONDATE

        public static final java.lang.String CREATIONDATE
        the creatation date of contract
        See Also:
        Constant Field Values
      • LAST_UPDATE

        public static final java.lang.String LAST_UPDATE
        the last update of contract
        See Also:
        Constant Field Values
      • ACTIVATIONDATE

        public static final java.lang.String ACTIVATIONDATE
        the activation date of contract
        See Also:
        Constant Field Values
      • DEACTIVATIONDATE

        public static final java.lang.String DEACTIVATIONDATE
        the desactication date of contract
        See Also:
        Constant Field Values
      • EVERYDATAOBJECTVERSION

        public static final java.lang.String EVERYDATAOBJECTVERSION
        the everydataobjectversion false by default
        See Also:
        Constant Field Values
      • MASTERMANDATORY

        public static final java.lang.String MASTERMANDATORY
        the MasterMandatory true by default
        See Also:
        Constant Field Values
      • FORMATUNIDENTIFIEDAUTHORIZED

        public static final java.lang.String FORMATUNIDENTIFIEDAUTHORIZED
        the FormatUnidentifiedAuthorized false by default
        See Also:
        Constant Field Values
      • EVERYFORMATTYPE

        public static final java.lang.String EVERYFORMATTYPE
        the EveryFormatType true by default
        See Also:
        Constant Field Values
      • MANAGEMENTCONTRACTID

        public static final java.lang.String MANAGEMENTCONTRACTID
        the identifier of a management contract
        See Also:
        Constant Field Values
    • Constructor Detail

      • IngestContract

        public IngestContract()
        Empty Constructor
      • IngestContract

        public IngestContract​(org.bson.Document document)
        Constructor
        Parameters:
        document - data in format Document to create contact
      • IngestContract

        public IngestContract​(com.fasterxml.jackson.databind.JsonNode content)
        Parameters:
        content - in format JsonNode to create contract
      • IngestContract

        public IngestContract​(java.lang.String content)
        Parameters:
        content - in format String to create contract
      • IngestContract

        public IngestContract​(java.lang.Integer tenantId)
        Parameters:
        tenantId - the working tenant
    • Method Detail

      • setId

        public IngestContract setId​(java.lang.String id)
        Parameters:
        id - the id of ingest contract
        Returns:
        AccessionRegisterDetail
      • getName

        public java.lang.String getName()
        Name of the contract
        Returns:
        name of contract
      • setName

        public IngestContract setName​(java.lang.String name)
        Set or change the contract name
        Parameters:
        name - to set
        Returns:
        this
      • getDescription

        public java.lang.String getDescription()
        Get the contract description
        Returns:
        this
      • setDescription

        public IngestContract setDescription​(java.lang.String description)
        Set or change the contract description
        Parameters:
        description - to set to contact
        Returns:
        this
      • getStatus

        public ActivationStatus getStatus()
        Get the contract status
        Returns:
        status of ingest contact
      • setStatus

        public IngestContract setStatus​(ActivationStatus status)
        Set or change the contract status
        Parameters:
        status - to set
        Returns:
        this
      • setCheckParentLink

        public IngestContract setCheckParentLink​(IngestContractCheckState checkParentLink)
        Set or change the contract status
        Parameters:
        checkParentLink - to set
        Returns:
        this
      • getCheckParentLink

        public IngestContractCheckState getCheckParentLink()
        Get the contract check ParentLink status
        Returns:
        status of checkParentLink for this ingest contact
      • getArchiveProfiles

        public java.util.Set<java.lang.String> getArchiveProfiles()
        Returns:
        collection of archive profiles
      • setArchiveProfiles

        public IngestContract setArchiveProfiles​(java.util.Set<java.lang.String> archiveProfiles)
        Set the collection of archive profiles
        Parameters:
        archiveProfiles -
        Returns:
        this
      • getCreationdate

        public java.lang.String getCreationdate()
        Returns:
        creation date of contract
      • setCreationdate

        public IngestContract setCreationdate​(java.lang.String creationdate)
        Parameters:
        creationdate - to set
        Returns:
        this
      • getLastupdate

        public java.lang.String getLastupdate()
        Returns:
        last update of contract
      • setLastupdate

        public IngestContract setLastupdate​(java.lang.String lastupdate)
        Parameters:
        lastupdate - to set
        Returns:
        this
      • getActivationdate

        public java.lang.String getActivationdate()
        Returns:
        activation date of contract
      • setActivationdate

        public IngestContract setActivationdate​(java.lang.String activationdate)
        Parameters:
        activationdate - to set
        Returns:
        this
      • getDeactivationdate

        public java.lang.String getDeactivationdate()
        Returns:
        desactivation date of contract
      • setDeactivationdate

        public IngestContract setDeactivationdate​(java.lang.String deactivationdate)
        Parameters:
        deactivationdate - to set
        Returns:
        this
      • getEveryDataObjectVersion

        public java.lang.Boolean getEveryDataObjectVersion()
      • setEveryDataObjectVersion

        public IngestContract setEveryDataObjectVersion​(boolean everyDataObjectVersion)
      • getMasterMandatory

        public java.lang.Boolean getMasterMandatory()
      • setMasterMandatory

        public IngestContract setMasterMandatory​(boolean masterMandatory)
      • getEveryFormatType

        public java.lang.Boolean getEveryFormatType()
      • setEveryFormatType

        public IngestContract setEveryFormatType​(boolean everyFormatType)
      • getFormatUnidentifiedAuthorized

        public java.lang.Boolean getFormatUnidentifiedAuthorized()
      • setFormatUnidentifiedAuthorized

        public IngestContract setFormatUnidentifiedAuthorized​(boolean formatUnidentifiedAuthorized)
      • setManagementContractId

        public IngestContract setManagementContractId​(java.lang.String managementContractId)
      • getManagementContractId

        public java.lang.String getManagementContractId()