com.hp.ucmdb.api.topology

Interface IndirectLinkDescriptor

@NotFinalAPI
public interface IndirectLinkDescriptor

A request descriptor for the "get the underlying paths" method.

The descriptor must hold at least one source id, one target id and one link name. These must correlate to the original topology (i.e. the original topology must have an indirect link result with the source CI having the source id, the target CI having the target id and the indirect link 'node name' matching the one given).

In addition, "properties to bring" may be defined for the entire result topology.

Since:

UCMDB 9.0

Method Summary

Modifier and Type	Method and Description
Set<String>	indirectLinkNames()
PropertiesCarrierWrapper	propertiesDefinition() Returns an object that may be used to define properties request for the underlying paths topology.
Set<UcmdbId>	sourceIds()
Set<UcmdbId>	targetIds()
IndirectLinkDescriptor	withIndirectLinkNames(Collection<String> names) Clears and sets the link names collection.
IndirectLinkDescriptor	withIndirectLinkNames(String... names) Clears and sets the link names collection.
IndirectLinkDescriptor	withSourceIds(Collection<UcmdbId> sourceIds) Clears and sets the source ids collection.
IndirectLinkDescriptor	withSourceIds(UcmdbId... sourceIds) Clears and sets the source ids collection.
IndirectLinkDescriptor	withTargetIds(Collection<UcmdbId> targetIds) Clears and sets the target ids collection.
IndirectLinkDescriptor	withTargetIds(UcmdbId... targetIds) Clears and sets the target ids collection.

Method Detail

withSourceIds

IndirectLinkDescriptor withSourceIds(Collection<UcmdbId> sourceIds)

Clears and sets the source ids collection.

Parameters:

sourceIds - the source ids.

Returns:

this object for method chaining.

withSourceIds

IndirectLinkDescriptor withSourceIds(UcmdbId... sourceIds)

Clears and sets the source ids collection.

Parameters:

sourceIds - the source ids.

Returns:

this object for method chaining.

sourceIds

Set<UcmdbId> sourceIds()

Returns:

the source ids collection.

withIndirectLinkNames

IndirectLinkDescriptor withIndirectLinkNames(Collection<String> names)

Clears and sets the link names collection.

Parameters:

names - the link names collection.

Returns:

this object for method chaining.

withIndirectLinkNames

IndirectLinkDescriptor withIndirectLinkNames(String... names)

Clears and sets the link names collection.

Parameters:

names - the link names collection.

Returns:

this object for method chaining.

indirectLinkNames

Set<String> indirectLinkNames()

Returns:

the link names colelction.

withTargetIds

IndirectLinkDescriptor withTargetIds(Collection<UcmdbId> targetIds)

Clears and sets the target ids collection.

Parameters:

targetIds - the target ids.

Returns:

this object for method chaining.

withTargetIds

IndirectLinkDescriptor withTargetIds(UcmdbId... targetIds)

Clears and sets the target ids collection.

Parameters:

targetIds - the target ids.

Returns:

this object for method chaining.

targetIds

Set<UcmdbId> targetIds()

Returns:

the target ids collection.

propertiesDefinition

PropertiesCarrierWrapper propertiesDefinition()

Returns an object that may be used to define properties request for the underlying paths topology.

Returns:

the object that should be used to define proeprties request.