info.magnolia.ui.api.availability

Interface AvailabilityDefinition

All Known Implementing Classes:

ConfiguredAvailabilityDefinition

public interface AvailabilityDefinition

Definition of restrictions on when subject is available.

Method Summary

Methods

Modifier and Type	Method and Description
info.magnolia.cms.security.operations.AccessDefinition	getAccess() Returns the AccessDefinition object for this subject.
Collection<String>	getNodeTypes() Unless this is empty the subject is available only for these node types.
Collection<? extends AvailabilityRuleDefinition>	getRules() Returns the collection of availability rule definitions for this subject.
boolean	isMultiple() If true, the subject is available for multiple item selection.
boolean	isNodes() If true the subject is available for nodes.
boolean	isProperties() If true the subject is available for properties.
boolean	isRoot() If true the subject is available when there's no selection.
boolean	isWritePermissionRequired() If true the subject is only available if write permission is granted for the item on which availability is evaluated.

Method Detail

isRoot

boolean isRoot()

If true the subject is available when there's no selection.

isProperties

boolean isProperties()

If true the subject is available for properties.

isNodes

boolean isNodes()

If true the subject is available for nodes.

isMultiple

boolean isMultiple()

If true, the subject is available for multiple item selection.

getNodeTypes

Collection<String> getNodeTypes()

Unless this is empty the subject is available only for these node types.

getAccess

info.magnolia.cms.security.operations.AccessDefinition getAccess()

Returns the AccessDefinition object for this subject.

isWritePermissionRequired

boolean isWritePermissionRequired()

If true the subject is only available if write permission is granted for the item on which availability is evaluated.

getRules

Collection<? extends AvailabilityRuleDefinition> getRules()

Returns the collection of availability rule definitions for this subject.