com.hpe.adm.nga.sdk.entities

Interface OctaneCollection<T extends Entity>

All Superinterfaces:

Collection<T>, Iterable<T>

public interface OctaneCollection<T extends Entity>
extends Collection<T>

An extension of the Collection interface that incorporates important metadata about the collection that has been returned. These are the total_count and exceeds_total_count fields. These are important when scrolling through paged data to know whether there is more data to fetch. Exceeds total count signifies whether the requested data page size is larger than allowed by server constraints. See the REST API documentation for more details

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_TOTAL_COUNT_SET Returned when the total count field has not been set

Method Summary

Modifier and Type	Method and Description
boolean	exceedsTotalCount() Whether the requested number of entities exceeds the total available number of entities
int	getTotalCount() The total count of available entities that answer to the current query

Methods inherited from interface java.util.Collection

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

NO_TOTAL_COUNT_SET

static final int NO_TOTAL_COUNT_SET

Returned when the total count field has not been set

See Also:

Constant Field Values

Method Detail

getTotalCount

int getTotalCount()

The total count of available entities that answer to the current query

Returns:

total count or NO_TOTAL_COUNT_SET if not set

exceedsTotalCount

boolean exceedsTotalCount()

Whether the requested number of entities exceeds the total available number of entities

Returns:

exceeds total count (false if not set as well)