com.hp.ucmdb.api.topology
Interface CIsChunk

public interface CIsChunk

The result of a retrieveCIsSortedChunk execution.

Ordered CIs can be retreived from this structure with the cis() method. These CIs cannot be modified. The current chunk index (zero based), total number of CIs matching the query and node name given in the retrieve request and the total number of chunks are also available.

Since:

UCMDB 9.0

Method Summary

int	chunkIndex() The chunk index.
java.util.List<CI>	cis() The ordered list of CIs cannot be modified.
java.util.Map<java.lang.String,java.lang.Integer>	getCIsMatchingQueryAndNodeClassCount() Returns the map of classes to count of CIs of each class from the CIs matching the requested node name in the query passed to retrieveCIsSortedChunk.
int	numberOfCIsMatchingQueryAndNode() The total number of CIs matching the node name in the query passed to retrieveCIsSortedChunk.
int	numberOfPossibleChunks() The total number of chunks.

Method Detail

cis

java.util.List<CI> cis()

The ordered list of CIs cannot be modified.

Returns:

the list of ordered CIs. Not null.

chunkIndex

int chunkIndex()

The chunk index.

Returns:

the chunk index.

numberOfCIsMatchingQueryAndNode

int numberOfCIsMatchingQueryAndNode()

The total number of CIs matching the node name in the query passed to retrieveCIsSortedChunk. Returns the total number of CIs in all chunks.

Returns:

the total number of CIs matching the requested node name.

getCIsMatchingQueryAndNodeClassCount

java.util.Map<java.lang.String,java.lang.Integer> getCIsMatchingQueryAndNodeClassCount()

Returns the map of classes to count of CIs of each class from the CIs matching the requested node name in the query passed to retrieveCIsSortedChunk. The count is for all chunks, and cannot be null.

Returns:

the count of CIs by class.

numberOfPossibleChunks

int numberOfPossibleChunks()

The total number of chunks.

Returns:

the total number of chunks.