de.espirit.firstspirit.agency

Interface ProjectRestriction

public interface ProjectRestriction

A restriction defining which and how a project shall be applied.

Since:

5.0.101

See Also:

SelectStoreElementOperation

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allows(IDProvider element) Evaluates, whether the project-restrictions allow the given element to pass.
boolean	autoReleaseAfterUpload() Indicates the project performing an auto release after upload.
String[]	getFolders(Store.Type type) Retrieves the folder restrictions for the given type.
String	getName() The project's symbolic name.
Store.Type[]	getStoreTypes() The store types to restrict the project use to.
String	getUploadFolder() The name of the folder to be used for uploads.

Method Detail

getName

@Nullable
String getName()

The project's symbolic name.

Returns:

The symbolic name or null, if the restriction refers to the local project.

Since:

5.0.101

getStoreTypes

Store.Type[] getStoreTypes()

The store types to restrict the project use to.

Returns:

The types of usable stores.

Since:

5.0.101

getFolders

@NotNull
String[] getFolders(Store.Type type)

Retrieves the folder restrictions for the given type.

Parameters:

type - The store type to retrieve restrictions for.

Returns:

The folders to restrict to.

Since:

5.0.101

getUploadFolder

String getUploadFolder()

The name of the folder to be used for uploads.

Returns:

The upload folder's name.

Since:

5.0.101

autoReleaseAfterUpload

boolean autoReleaseAfterUpload()

Indicates the project performing an auto release after upload.

Returns:

If true, project does auto release after upload.

Since:

5.0.101

allows

boolean allows(IDProvider element)

Evaluates, whether the project-restrictions allow the given element to pass.

Parameters:

element - The element to check upon.

Returns:

true, if the restrictions allow the element.

Since:

5.0.101