senselogic.sitevision.api.search.searcher.builder

Interface PermissionCheckBuilder

All Superinterfaces:

Builder<PermissionCheck>

@Requireable(value="PermissionCheckBuilder")
public interface PermissionCheckBuilder
extends Builder<PermissionCheck>

Builder for creating a PermissionCheck component.

PermissionCheck has one optional attribute:

• permission strategy - the permission checking strategy. Default is PermissionStrategy.EARLY_CHECK.

Tip! The Builder interface documentation contains more information about Builders and how to work with them!

An instance of the Sitevision class implementing this interface can be obtained via SearchFactory.getPermissionCheckBuilder(). See SearchFactory for how to obtain an instance of the SearchFactory interface.

Since:

Sitevision 2023.09.1

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
PermissionCheck	build() Creates a PermissionCheck component instance using currently specified state/behaviour.
PermissionCheckBuilder	setPermissionStrategy(PermissionStrategy aPermissionStrategy) Sets the permission strategy.

Method Detail

setPermissionStrategy

PermissionCheckBuilder setPermissionStrategy(PermissionStrategy aPermissionStrategy)

Sets the permission strategy.

Parameters:

aPermissionStrategy - the permission strategy

Returns:

this builder

build

PermissionCheck build()

Creates a PermissionCheck component instance using currently specified state/behaviour.

Default strategy PermissionStrategy.EARLY_CHECK will be used if the component has no state (i.e. no PermissionStrategy explicitly set) when built.

Specified by:

build in interface Builder<PermissionCheck>

Returns:

a permission check component