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 Summary

Fields

Modifier and Type	Field and Description
static String	ACCESS_LOG Work for access log
static String	DATA_OBJECT_VERSION DataObjectVersion
static String	EVERY_DATA_OBJECT_VERSION Work for all data object version
static String	EVERY_ORIGINATINGAGENCY Work for all originating agencies
static String	EXCLUDED_ROOT_UNITS Excluded root units
static String	ORIGINATING_AGENCIES OriginatingAgencies
static String	ROOT_UNITS Root units

Fields inherited from class fr.gouv.vitam.common.model.administration.AbstractContractModel

TAG_CREATION_DATE, TAG_DESCRIPTION, TAG_IDENTIFIER, TAG_LAST_UPDATE, TAG_NAME, TAG_STATUS

Constructor Summary

Constructors

Constructor and Description
AccessContractModel() Constructor without fields use for jackson

Method Summary

Modifier and Type	Method and Description
ActivationStatus	getAccessLog()
Set<String>	getDataObjectVersion()
Boolean	getEveryOriginatingAgency()
Set<String>	getExcludedRootUnits()
Set<String>	getOriginatingAgencies() Get the collection of originating agency
Set<String>	getRootUnits()
Boolean	getWritingPermission()
Boolean	getWritingRestrictedDesc()
void	initializeDefaultValue()
Boolean	isEveryDataObjectVersion()
AccessContractModel	setAccessLog(ActivationStatus accessLog)
AccessContractModel	setDataObjectVersion(Set<String> dataObjectVersion)
AccessContractModel	setEveryDataObjectVersion(Boolean everyDataObjectVersion) Set the 'everyDataObjectVersion' flag on the contract.
AccessContractModel	setEveryOriginatingAgency(Boolean everyOriginatingAgency) Set the 'everyOriginatingAgency' flag on the contract.
AccessContractModel	setExcludedRootUnits(Set<String> excludedRootUnits) Collection of archive units' GUIDs.
AccessContractModel	setOriginatingAgencies(Set<String> originatingAgencies) Set the collection of originating agency
AccessContractModel	setRootUnits(Set<String> rootUnits) Collection of GUID of archive units.
AccessContractModel	setWritingPermission(Boolean writingPermission)
AccessContractModel	setWritingRestrictedDesc(Boolean writingRestrictedDesc)

Methods inherited from class fr.gouv.vitam.common.model.administration.AbstractContractModel

getActivationdate, getCreationdate, getDeactivationdate, getDescription, getId, getIdentifier, getLastupdate, getName, getStatus, getTenant, getVersion, setActivationdate, setCreationdate, setDeactivationdate, setDescription, setId, setIdentifier, setLastupdate, setName, setStatus, setTenant, setVersion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ORIGINATING_AGENCIES

public static final String ORIGINATING_AGENCIES

OriginatingAgencies

See Also:

Constant Field Values

ROOT_UNITS

public static final String ROOT_UNITS

Root units

See Also:

Constant Field Values

EXCLUDED_ROOT_UNITS

public static final String EXCLUDED_ROOT_UNITS

Excluded root units

See Also:

Constant Field Values

DATA_OBJECT_VERSION

public static final String DATA_OBJECT_VERSION

DataObjectVersion

See Also:

Constant Field Values

EVERY_DATA_OBJECT_VERSION

public static final String EVERY_DATA_OBJECT_VERSION

Work for all data object version

See Also:

Constant Field Values

EVERY_ORIGINATINGAGENCY

public static final String EVERY_ORIGINATINGAGENCY

Work for all originating agencies

See Also:

Constant Field Values

ACCESS_LOG

public static final String ACCESS_LOG

Work for access log

See Also:

Constant Field Values

Constructor Detail

AccessContractModel

public AccessContractModel()

Constructor without fields use for jackson

Method Detail

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

Parameters:

originatingAgencies -

getDataObjectVersion

public Set<String> getDataObjectVersion()

Returns:

dataObjectVersion

setDataObjectVersion

public AccessContractModel setDataObjectVersion(Set<String> dataObjectVersion)

Parameters:

dataObjectVersion -

Returns:

AccessContractModel

getWritingPermission

public Boolean getWritingPermission()

Returns:

writingPermission

setWritingPermission

public AccessContractModel setWritingPermission(Boolean writingPermission)

Parameters:

writingPermission -

Returns:

AccessContractModel

getWritingRestrictedDesc

public Boolean getWritingRestrictedDesc()

Returns:

writingRestrictedDesc

setWritingRestrictedDesc

public AccessContractModel setWritingRestrictedDesc(Boolean writingRestrictedDesc)

Parameters:

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

isEveryDataObjectVersion

public Boolean isEveryDataObjectVersion()

Returns:

true if all data object version are enabled for this contract

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)

initializeDefaultValue

public void initializeDefaultValue()