Enum Class FieldAccessTier
java.lang.Object
java.lang.Enum<FieldAccessTier>
com.kingsrook.qqq.backend.core.actions.permissions.fieldaccess.FieldAccessTier
- All Implemented Interfaces:
Serializable,Comparable<FieldAccessTier>,Constable
Effective field access, ordered from least to most restrictive.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum Constants -
Method Summary
Modifier and TypeMethodDescriptionbooleancanFilter(QCriteriaOperator operator) Whether the operator is available for this tier.booleancanGroupOrAggregatebooleancanQuickSearchbooleancanReadValuebooleancanSort()canSortbooleancanWrite()canWritebooleanWhether the field may be described to the caller.leastRestrictive(FieldAccessTier other) Combine tiers; null means FULL.mostRestrictive(FieldAccessTier other) Combine tiers; null means FULL.static FieldAccessTierReturns the enum constant of this class with the specified name.static FieldAccessTier[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
FULL
-
REVEALABLE
-
MASKED
-
HIDDEN
-
-
Method Details
-
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
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 nameNullPointerException- if the argument is null
-
canReadValue
public boolean canReadValue()canReadValue -
canSort
public boolean canSort()canSort -
canGroupOrAggregate
public boolean canGroupOrAggregate()canGroupOrAggregate -
canQuickSearch
public boolean canQuickSearch()canQuickSearch -
canWrite
public boolean canWrite()canWrite -
canFilter
Whether the operator is available for this tier. -
isInMetaData
public boolean isInMetaData()Whether the field may be described to the caller. -
mostRestrictive
Combine tiers; null means FULL. -
leastRestrictive
Combine tiers; null means FULL.
-