Package fr.gouv.vitam.common.model.administration

Class AccessContractModel

java.lang.Object
fr.gouv.vitam.common.model.administration.AbstractContractModel
fr.gouv.vitam.common.model.administration.AccessContractModel
public class AccessContractModel extends AbstractContractModel
Data Transfer Object Model of access contract (DTO).

  • Field Details

  • Constructor Details

    • AccessContractModel

      public AccessContractModel()
      Constructor without fields use for jackson

  • Method Details

    • getOriginatingAgencies

      public Set<String> getOriginatingAgencies()
      Get the collection of originating agency
      Returns:
      originatingAgencies collection

    • setOriginatingAgencies

      public AccessContractModel setOriginatingAgencies(Set<String> originatingAgencies)
      Set the collection of originating agency

    • getDataObjectVersion

      public Set<String> getDataObjectVersion()
      Returns:
      dataObjectVersion

    • setDataObjectVersion

      public AccessContractModel setDataObjectVersion(Set<String> dataObjectVersion)
      Returns:
      AccessContractModel

    • getWritingPermission

      public Boolean getWritingPermission()
      Returns:
      writingPermission

    • setWritingPermission

      public AccessContractModel setWritingPermission(Boolean writingPermission)
      Returns:
      AccessContractModel

    • getWritingRestrictedDesc

      public Boolean getWritingRestrictedDesc()
      Returns:
      writingRestrictedDesc

    • setWritingRestrictedDesc

      public AccessContractModel setWritingRestrictedDesc(Boolean writingRestrictedDesc)
      Returns:
      AccessContractModel

    • getEveryOriginatingAgency

      public Boolean getEveryOriginatingAgency()
      Returns:
      true if all originatingAgencies are enabled for this contract

    • setEveryOriginatingAgency

      public AccessContractModel setEveryOriginatingAgency(Boolean everyOriginatingAgency)
      Set the 'everyOriginatingAgency' flag on the contract.
      Parameters:
      everyOriginatingAgency - If true, all originatingAgencies are enabled for this contract
      Returns:
      the contract

    • getEveryDataObjectVersion

      public Boolean getEveryDataObjectVersion()
      Returns:
      true if all data object version are enabled for this contract

    • isEveryDataObjectVersion

      @Deprecated(forRemoval=true, since="8.0") public Boolean isEveryDataObjectVersion()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 8.0, replaced with getEveryDataObjectVersion()

    • setEveryDataObjectVersion

      public AccessContractModel setEveryDataObjectVersion(Boolean everyDataObjectVersion)
      Set the 'everyDataObjectVersion' flag on the contract.
      Parameters:
      everyDataObjectVersion - if true, all data object version are enabled for this contract
      Returns:
      this

    • getRootUnits

      public Set<String> getRootUnits()
      Returns:
      the root units

    • setRootUnits

      public AccessContractModel setRootUnits(Set<String> rootUnits)
      Collection of GUID of archive units. If not empty, access is restricted only to the given rootUnits and there childs. Access not permitted to parent units of the rootUnits Access not permitted to parent units of the rootUnits
      Parameters:
      rootUnits - collection of guid of units (can be empty)
      Returns:
      this

    • getExcludedRootUnits

      public Set<String> getExcludedRootUnits()
      Returns:
      the excluded root units

    • setExcludedRootUnits

      public AccessContractModel setExcludedRootUnits(Set<String> excludedRootUnits)
      Collection of archive units' GUIDs. If not empty then access is forbidden to given unit and its children.
      Parameters:
      excludedRootUnits - collection of guid of units (can be empty)
      Returns:
      this

    • getAccessLog

      public ActivationStatus getAccessLog()

    • setAccessLog

      public AccessContractModel setAccessLog(ActivationStatus accessLog)

    • getRuleCategoryToFilter

      public Set<RuleType> getRuleCategoryToFilter()

    • setRuleCategoryToFilter

      public AccessContractModel setRuleCategoryToFilter(Set<RuleType> ruleCategoryToFilter)

    • getRuleCategoryToFilterForTheOtherOriginatingAgencies

      public Set<RuleType> getRuleCategoryToFilterForTheOtherOriginatingAgencies()

    • setRuleCategoryToFilterForTheOtherOriginatingAgencies

      public AccessContractModel setRuleCategoryToFilterForTheOtherOriginatingAgencies(Set<RuleType> ruleCategoryToFilterForTheOtherOriginatingAgencies)

    • getSkipFilingSchemeRuleCategoryFilter

      public Boolean getSkipFilingSchemeRuleCategoryFilter()

    • setSkipFilingSchemeRuleCategoryFilter

      public AccessContractModel setSkipFilingSchemeRuleCategoryFilter(Boolean skipFilingSchemeRuleCategoryFilter)

    • getDoNotFilterFilingSchemes

      public Boolean getDoNotFilterFilingSchemes()

    • setDoNotFilterFilingSchemes

      public AccessContractModel setDoNotFilterFilingSchemes(Boolean doNotFilterFilingSchemes)

    • initializeDefaultValue

      public void initializeDefaultValue()