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

Class AccessContractModel

  • public class AccessContractModel
extends AbstractContractModel
    Data Transfer Object Model of access contract (DTO).

    • Field Detail

      • ORIGINATING_AGENCIES

        public static final java.lang.String ORIGINATING_AGENCIES
        OriginatingAgencies
        See Also:
        Constant Field Values

      • EXCLUDED_ROOT_UNITS

        public static final java.lang.String EXCLUDED_ROOT_UNITS
        Excluded root units
        See Also:
        Constant Field Values

      • DATA_OBJECT_VERSION

        public static final java.lang.String DATA_OBJECT_VERSION
        DataObjectVersion
        See Also:
        Constant Field Values

      • EVERY_DATA_OBJECT_VERSION

        public static final java.lang.String EVERY_DATA_OBJECT_VERSION
        Work for all data object version
        See Also:
        Constant Field Values

      • EVERY_ORIGINATINGAGENCY

        public static final java.lang.String EVERY_ORIGINATINGAGENCY
        Work for all originating agencies
        See Also:
        Constant Field Values

      • RULE_CATEGORY_TO_FILTER

        public static final java.lang.String RULE_CATEGORY_TO_FILTER
        See Also:
        Constant Field Values

    • Constructor Detail

      • AccessContractModel

        public AccessContractModel()
        Constructor without fields use for jackson

    • Method Detail

      • getOriginatingAgencies

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

      • setOriginatingAgencies

        public AccessContractModel setOriginatingAgencies​(java.util.Set<java.lang.String> originatingAgencies)
        Set the collection of originating agency
        Parameters:
        originatingAgencies -

      • getDataObjectVersion

        public java.util.Set<java.lang.String> getDataObjectVersion()
        Returns:
        dataObjectVersion

      • setDataObjectVersion

        public AccessContractModel setDataObjectVersion​(java.util.Set<java.lang.String> dataObjectVersion)
        Parameters:
        dataObjectVersion -
        Returns:
        AccessContractModel

      • getWritingPermission

        public java.lang.Boolean getWritingPermission()
        Returns:
        writingPermission

      • setWritingPermission

        public AccessContractModel setWritingPermission​(java.lang.Boolean writingPermission)
        Parameters:
        writingPermission -
        Returns:
        AccessContractModel

      • getWritingRestrictedDesc

        public java.lang.Boolean getWritingRestrictedDesc()
        Returns:
        writingRestrictedDesc

      • getEveryOriginatingAgency

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

      • setEveryOriginatingAgency

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

      • isEveryDataObjectVersion

        public java.lang.Boolean isEveryDataObjectVersion()
        Returns:
        true if all data object version are enabled for this contract

      • setEveryDataObjectVersion

        public AccessContractModel setEveryDataObjectVersion​(java.lang.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 java.util.Set<java.lang.String> getRootUnits()
        Returns:
        the root units

      • setRootUnits

        public AccessContractModel setRootUnits​(java.util.Set<java.lang.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 java.util.Set<java.lang.String> getExcludedRootUnits()
        Returns:
        the excluded root units

      • setExcludedRootUnits

        public AccessContractModel setExcludedRootUnits​(java.util.Set<java.lang.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

      • getRuleCategoryToFilter

        public java.util.Set<RuleType> getRuleCategoryToFilter()

      • initializeDefaultValue

        public void initializeDefaultValue()