Package de.espirit.firstspirit.access.store.templatestore.gom

Enum Class GomFilterEntry.FilterType

java.lang.Object

java.lang.Enum<GomFilterEntry.FilterType>

de.espirit.firstspirit.access.store.templatestore.gom.GomFilterEntry.FilterType

All Implemented Interfaces:

Serializable, Comparable<GomFilterEntry.FilterType>, Constable

Enclosing interface:

GomFilterEntry

public static enum GomFilterEntry.FilterType
extends Enum<GomFilterEntry.FilterType>

Allowed element selection types.

Since:

4.2.9

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GomFilterEntry.FilterType.All	Wildcard type matching any element
static class	GomFilterEntry.FilterType.Folders	Virtual FOLRDER wildcard type.
static enum	GomFilterEntry.FilterType.WildCardFilterTypesRegistry	Filter types matching all elements of a specific type

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Element wildcard type to allow/hide all
CONTENT2	Element type to allow/hide CONTENT selections.
CONTENTFOLDER	Element type to allow/hide CONTENTFOLDER navigation.
DOCUMENTGROUP	Element type to allow/hide DOCUMENTGROUP selections
FILE	Element type to allow/hide FILE selections.
FOLDERS	Element wildcard type to allow/hide all FOLDERS
FORMATTEMPLATE	Element type to allow/hide FORMATTEMPLATE selections
FORMATTEMPLATEFOLDER	Element type to allow/hide FORMATTEMPLATEFOLDER for navigation
GCAFOLDER	Element type to allow/hide GCAFOLDER navigation
GCAPAGE	Element type to allow/hide GCAPAGE selections
LINKTEMPLATE	Element type to allow/hide LINKTEMPLATE selections
LINKTEMPLATEFOLDER	Deprecated. since 5.2.14 - no replacement
MEDIA	Element type to allow/hide all types of PICTURE and FILE
MEDIAFOLDER	Element type to allow/hide MEDIAFOLDER selections.
PAGE	Element type to allow/hide PAGE selections.
PAGEFOLDER	Element type to allow/hide PAGEFOLDER selections.
PAGEREF	Element type to allow/hide PAGEREF selections.
PAGEREFFOLDER	Element type to allow/hide PAGEREFFOLDER selections.
PICTURE	Element type to allow/hide PICTURE selections.
SCHEMA	Element type to allow/hide SCHEMA selections
SCRIPT	Element type to allow/hide SCRIPT selections
SECTIONTEMPLATE	Element type to allow/hide SECTIONTEMPLATE selections
SITESTOREFOLDER	Element type to allow/hide SITESTOREFFOLDER selections.
STYLETEMPLATE	Element type to allow/hide STYLETEMPLATE selections
TABLEFORMATTEMPLATE	Element type to allow/hide TABLEFORMATTEMPLATE selections
TEMPLATE	Element type to allow/hide TEMPLATE selections
TEMPLATEFOLDER	Element type to allow/hide TEMPLATEFOLDER for navigation
WORKFLOW	Element type to allow/hide WORKFLOW selections

Method Summary

Modifier and Type	Method	Description
static GomFilterEntry.FilterType	forName(@NotNull String name)	Converts the given name to a filter type
static @NotNull GomFilterEntry.FilterType	fromType(Class<?> type)	Retrieves the matching filter type for a class
List<Class<? extends StoreElement>>	getExcludes()	Excludes act as a blacklist.
String	getStringRepresentation()	The string representation of the filter
Class<?>	getType()	The type of the filter
boolean	hasUid()	Indicates if the filter has a uid.
boolean	isBlacklisted(Class<? extends StoreElement> element)	Indicates if the given element is blacklisted
static GomFilterEntry.FilterType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GomFilterEntry.FilterType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PICTURE

public static final GomFilterEntry.FilterType PICTURE

Element type to allow/hide PICTURE selections.

Since:

4.2

FILE

public static final GomFilterEntry.FilterType FILE

Element type to allow/hide FILE selections.

Since:

4.2

MEDIAFOLDER

public static final GomFilterEntry.FilterType MEDIAFOLDER

Element type to allow/hide MEDIAFOLDER selections.

Since:

4.2

PAGEREFFOLDER

public static final GomFilterEntry.FilterType PAGEREFFOLDER

Element type to allow/hide PAGEREFFOLDER selections.

Since:

4.2

PAGEREF

public static final GomFilterEntry.FilterType PAGEREF

Element type to allow/hide PAGEREF selections.

Since:

4.2

PAGE

public static final GomFilterEntry.FilterType PAGE

Element type to allow/hide PAGE selections.

Since:

4.2

PAGEFOLDER

public static final GomFilterEntry.FilterType PAGEFOLDER

Element type to allow/hide PAGEFOLDER selections.

Since:

4.2

SITESTOREFOLDER

public static final GomFilterEntry.FilterType SITESTOREFOLDER

Element type to allow/hide SITESTOREFFOLDER selections.

Since:

4.2

CONTENT2

public static final GomFilterEntry.FilterType CONTENT2

Element type to allow/hide CONTENT selections.

Since:

4.2

CONTENTFOLDER

public static final GomFilterEntry.FilterType CONTENTFOLDER

Element type to allow/hide CONTENTFOLDER navigation.

Since:

4.2

DOCUMENTGROUP

public static final GomFilterEntry.FilterType DOCUMENTGROUP

Element type to allow/hide DOCUMENTGROUP selections

Since:

4.2

GCAFOLDER

public static final GomFilterEntry.FilterType GCAFOLDER

Element type to allow/hide GCAFOLDER navigation

Since:

4.2

GCAPAGE

public static final GomFilterEntry.FilterType GCAPAGE

Element type to allow/hide GCAPAGE selections

Since:

4.2

TEMPLATE

public static final GomFilterEntry.FilterType TEMPLATE

Element type to allow/hide TEMPLATE selections

Since:

4.2

TEMPLATEFOLDER

public static final GomFilterEntry.FilterType TEMPLATEFOLDER

Element type to allow/hide TEMPLATEFOLDER for navigation

Since:

4.2

LINKTEMPLATEFOLDER

@Deprecated(since="5.2.14")
public static final GomFilterEntry.FilterType LINKTEMPLATEFOLDER

Deprecated.

since 5.2.14 - no replacement

Element type to allow/hide LINKTEMPLATEFOLDER for navigation

Since:

4.2

FORMATTEMPLATE

public static final GomFilterEntry.FilterType FORMATTEMPLATE

Element type to allow/hide FORMATTEMPLATE selections

Since:

4.2

SECTIONTEMPLATE

public static final GomFilterEntry.FilterType SECTIONTEMPLATE

Element type to allow/hide SECTIONTEMPLATE selections

Since:

4.2

LINKTEMPLATE

public static final GomFilterEntry.FilterType LINKTEMPLATE

Element type to allow/hide LINKTEMPLATE selections

Since:

4.2

FORMATTEMPLATEFOLDER

public static final GomFilterEntry.FilterType FORMATTEMPLATEFOLDER

Element type to allow/hide FORMATTEMPLATEFOLDER for navigation

Since:

4.2

STYLETEMPLATE

public static final GomFilterEntry.FilterType STYLETEMPLATE

Element type to allow/hide STYLETEMPLATE selections

Since:

5.0

TABLEFORMATTEMPLATE

public static final GomFilterEntry.FilterType TABLEFORMATTEMPLATE

Element type to allow/hide TABLEFORMATTEMPLATE selections

Since:

5.0

SCRIPT

public static final GomFilterEntry.FilterType SCRIPT

Element type to allow/hide SCRIPT selections

Since:

5.0

SCHEMA

public static final GomFilterEntry.FilterType SCHEMA

Element type to allow/hide SCHEMA selections

Since:

5.0

WORKFLOW

public static final GomFilterEntry.FilterType WORKFLOW

Element type to allow/hide WORKFLOW selections

Since:

5.0

MEDIA

public static final GomFilterEntry.FilterType MEDIA

Element type to allow/hide all types of PICTURE and FILE

Since:

4.2

FOLDERS

public static final GomFilterEntry.FilterType FOLDERS

Element wildcard type to allow/hide all FOLDERS

Since:

4.2

ALL

public static final GomFilterEntry.FilterType ALL

Element wildcard type to allow/hide all

Since:

4.2

Method Details

values

public static GomFilterEntry.FilterType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static GomFilterEntry.FilterType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getType

public Class<?> getType()

The type of the filter

Since:

4.2.9

hasUid

public boolean hasUid()

Indicates if the filter has a uid.

Since:

5.2.2

getStringRepresentation

public String getStringRepresentation()

The string representation of the filter

Since:

4.2.9

forName

public static GomFilterEntry.FilterType forName(@NotNull
 @NotNull String name)

Converts the given name to a filter type

Parameters:

name - the name of the filter type

Since:

4.2.9

fromType

@NotNull
public static @NotNull GomFilterEntry.FilterType fromType(Class<?> type)

Retrieves the matching filter type for a class

Parameters:

type - the class to match

Since:

5.0

getExcludes

public List<Class<? extends StoreElement>> getExcludes()

Excludes act as a blacklist.

Since:

5.2.13

isBlacklisted

public boolean isBlacklisted(Class<? extends StoreElement> element)

Indicates if the given element is blacklisted

Parameters:

element - The element to check

Returns:

true if the element is blacklisted, false otherwise

Since:

5.2.13