com.hp.ucmdb.api.topology.reachableset

Interface ReachableSetDefinition

public interface ReachableSetDefinition

This interface allows querying and changing properties related to the entire reachable set.

Since:

UCMDB 9.0

See Also:

QueryNode.withReachableSetStep()

Method Summary

Modifier and Type	Method and Description
EmptyReachableSetStep	addStep() Adds a step to this reachable set.
String	linksName() Returns the name for the step links.
int	maxNumberOfStepsMatched() Returns the maxNumberOfStepsMatched.
String	nodesName() Returns the name for the step nodes.
Collection<? extends ReachableSetStep>	steps() Returns the steps collection for this reachable set.
QueryNode	toQueryNode() Returns to the QueryNode containing this reachable set.
ReachableSetDefinition	withLinksName(String name) Defines the name for the links identified by the steps in this reachable set.
ReachableSetDefinition	withMaxNumberOfStepsMatched(int maxNumberOfStepsMatched) Sets the maximum number of steps that should be searched for when matching this reachable set.
ReachableSetDefinition	withNodesName(String name) Defines the name for the nodes identified by the steps in this reachable set.

Method Detail

toQueryNode

QueryNode toQueryNode()

Returns to the QueryNode containing this reachable set.

addStep

EmptyReachableSetStep addStep()

Adds a step to this reachable set.

steps

Collection<? extends ReachableSetStep> steps()

Returns the steps collection for this reachable set.

withMaxNumberOfStepsMatched

ReachableSetDefinition withMaxNumberOfStepsMatched(int maxNumberOfStepsMatched)

Sets the maximum number of steps that should be searched for when matching this reachable set. This effectively limits the reachable set size. The default is 5.

Parameters:

maxNumberOfStepsMatched - a positive number (>=1).

Returns:

this object. The returned object can be used for method chaining.

See Also:

maxNumberOfStepsMatched()

maxNumberOfStepsMatched

int maxNumberOfStepsMatched()

Returns the maxNumberOfStepsMatched.

See Also:

withMaxNumberOfStepsMatched(int).

withNodesName

ReachableSetDefinition withNodesName(String name)

Defines the name for the nodes identified by the steps in this reachable set. In the topology, it will be possible to identify the nodes using this name. All the nodes from all the steps of this reachable set share the same name.

Returns:

this object. The returned object can be used for method chaining.

See Also:

nodesName()

nodesName

String nodesName()

Returns the name for the step nodes.

See Also:

withNodesName(String)

withLinksName

ReachableSetDefinition withLinksName(String name)

Defines the name for the links identified by the steps in this reachable set. In the topology, it will be possible to identify the links using this name. All the links from all the steps of this reachable set share the same name.

Returns:

this object. The returned object can be used for method chaining.

See Also:

nodesName()

linksName

String linksName()

Returns the name for the step links.

See Also:

withLinksName(String)