com.hp.ucmdb.api.view

Interface ViewExecutionOptions

@NotFinalAPI
public interface ViewExecutionOptions

A container for view execution options and flags, this object may change view execution behavior at runtime.

This object can be created with ViewFactory.createOptions().

Defaults for this object are:

• With label.
• With icon.
• Without note.
• Without query properties.
• Without view properties.

Since:

UCMDB 9.0

Method Summary

Modifier and Type	Method and Description
ViewExecutionOptions	withNote() Adds the "note" functionality to ViewResultTreeNodes based on CIs.
ViewExecutionOptions	withoutIcon() Removes the "icon function" functionality from ViewResultTreeNodes based on CIs.
ViewExecutionOptions	withoutLabel() Removes the "label" functionality from ViewResultTreeNodes based on CIs.
ViewExecutionOptions	withQueryNodePagination(ViewPagination pagination)
ViewExecutionOptions	withQueryProperties() Adds the query properties to the CIs and Relations in the ViewResult.topology().
ViewExecutionOptions	withSyntheticNodePagination(ViewPagination pagination)
ViewExecutionOptions	withViewProperties() Adds the "View Properties" functionality to ViewResultTreeNodes.
ViewExecutionOptions	withViewSearch(ViewSimpleSearch viewSimpleSearch)

Method Detail

withoutLabel

ViewExecutionOptions withoutLabel()

Removes the "label" functionality from ViewResultTreeNodes based on CIs. Calls to ViewResultTreeNode.label() will yield a default "no label" String.

The label may still work, on some ViewResultTreeNodes (or all) if the label property is brought by another option.

Returns:

"this", for method chaining.

withoutIcon

ViewExecutionOptions withoutIcon()

Removes the "icon function" functionality from ViewResultTreeNodes based on CIs. Calls to ViewResultTreeNode.iconName() will yield the icon based on the CI class type and not on the "icon function" which may be defined on that type.

The "icon function" may still work, on some ViewResultTreeNodes (or all) if the icon function property is brought by another option.

Returns:

"this", for method chaining.

withNote

ViewExecutionOptions withNote()

Adds the "note" functionality to ViewResultTreeNodes based on CIs. Calls to ViewResultTreeNode.note() return the note attached to the CI, or empty String if no note is available.

Returns:

"this", for method chaining.

withQueryProperties

ViewExecutionOptions withQueryProperties()

Adds the query properties to the CIs and Relations in the ViewResult.topology().

Returns:

"this", for method chaining.

withViewProperties

ViewExecutionOptions withViewProperties()

Adds the "View Properties" functionality to ViewResultTreeNodes. Calls to ViewResultTreeNode.viewProperties() will yield the view properties for the node, as defined by the view attributes in the definition.

Returns:

"this", for method chaining.

withQueryNodePagination

ViewExecutionOptions withQueryNodePagination(ViewPagination pagination)

withSyntheticNodePagination

ViewExecutionOptions withSyntheticNodePagination(ViewPagination pagination)

withViewSearch

ViewExecutionOptions withViewSearch(ViewSimpleSearch viewSimpleSearch)