Package com.hybris.backoffice.widgets.perspectivechooser.perspectiveresolver

Interface DefaultPerspectiveResolver

All Superinterfaces:

ActionsResolver

All Known Implementing Classes:

AuthorityGroupDefaultPerspectiveResolver, SequenceDefaultPerspectiveResolver, TreePerspectiveResolver

public interface DefaultPerspectiveResolver
extends ActionsResolver

Interface to be implemented by objects that can resolve default perspective from NavigationTree.

Method Summary

Modifier and Type	Method	Description
default NavigationTree	formTree(java.util.Collection<? extends ActionDefinition> actions)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 - use formTree(Collection, WidgetInstanceManager)
default NavigationTree	formTree(java.util.Collection<? extends ActionDefinition> actions, WidgetInstanceManager widgetInstanceManager)	Goes through all provided actions and forms then in the shape of navigation action tree.
default java.util.List<NavigationNode>	getPermittedPerspectives(NavigationTree navigationTree)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.5, allowed perspectives configuration has been moved to View Switcher widget
NavigationNode	resolveDefaultPerspective(NavigationTree navigationTree)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 - use resolveDefaultPerspective(NavigationTree, WidgetInstanceManager)
default NavigationNode	resolveDefaultPerspective(NavigationTree navigationTree, WidgetInstanceManager widgetInstanceManager)	Resolve default perspective.

Method Detail

resolveDefaultPerspective

@Deprecated(since="6.7",
            forRemoval=true)
NavigationNode resolveDefaultPerspective(NavigationTree navigationTree)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 - use resolveDefaultPerspective(NavigationTree, WidgetInstanceManager)

Resolve default perspective.

To allow chaining, a DefaultPerspectiveResolver implementation should return null when a default perspective cannot be found.

Parameters:

navigationTree - navigation tree containing perspective, from which a default one should be picked

Returns:

the NavigationNode, or null if not found

See Also:

AuthorityGroupDefaultPerspectiveResolver, SequenceDefaultPerspectiveResolver

resolveDefaultPerspective

default NavigationNode resolveDefaultPerspective(NavigationTree navigationTree,
                                                 WidgetInstanceManager widgetInstanceManager)

Resolve default perspective.

To allow chaining, a DefaultPerspectiveResolver implementation should return null when a default perspective cannot be found.

Parameters:

navigationTree - navigation tree containing perspective, from which a default one should be picked

widgetInstanceManager - widget instance manager

Returns:

the NavigationNode, or null if not found

See Also:

AuthorityGroupDefaultPerspectiveResolver, SequenceDefaultPerspectiveResolver

getPermittedPerspectives

@Deprecated(since="6.5",
            forRemoval=true)
default java.util.List<NavigationNode> getPermittedPerspectives(NavigationTree navigationTree)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.5, allowed perspectives configuration has been moved to View Switcher widget

Returns all permitted perspectives.

To allow chaining, a DefaultPerspectiveResolver implementation should return null or empty list when a permitted perspectives cannot be found.

Parameters:

navigationTree - full navigation tree containing perspective, from which a permitted one should be picked

Returns:

the list of permitted NavigationNode, or empty list if not found

See Also:

AuthorityGroupDefaultPerspectiveResolver, ViewSwitcherWidgetController.filterPossibleWidgets(List)

formTree

@Deprecated(since="6.7",
            forRemoval=true)
default NavigationTree formTree(java.util.Collection<? extends ActionDefinition> actions)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 - use formTree(Collection, WidgetInstanceManager)

Goes through all provided actions and forms then in the shape of navigation action tree.

Specified by:

formTree in interface ActionsResolver

Parameters:

actions - actions to be formed

Returns:

navigation tree

formTree

default NavigationTree formTree(java.util.Collection<? extends ActionDefinition> actions,
                                WidgetInstanceManager widgetInstanceManager)

Goes through all provided actions and forms then in the shape of navigation action tree.

Specified by:

formTree in interface ActionsResolver

Parameters:

actions - actions to be formed

widgetInstanceManager - widget instance manager

Returns:

navigation tree