IResourceCollectionEnumerator<T> Interface

Package:

com.microsoft.store.partnercenter.enumerators

Maven Artifact:

com.microsoft.store:partnercenter:1.15.3

Type Parameters

T

public interface IResourceCollectionEnumerator<T>

Provides resource collection enumeration capabilities. This interface can page through results and determines whether the current page is the first or last page or not. The enumeration result type.

Method Summary

Modifier and Type	Method and Description
abstract T	getCurrent() The current resource collection.
abstract boolean	hasValue() Gets whether the current result collection has a value or not.
abstract boolean	isFirstPage() Gets whether the current result collection is the first page of results or not.
abstract boolean	isLastPage() Gets whether the current result collection is the last page of results or not.
abstract void	next() Retrieves the next result set.
abstract void	next(IRequestContext context) Retrieves the next result set.
abstract void	previous() Retrieves the previous result set.
abstract void	previous(IRequestContext context) Retrieves the previous result set.

Method Details

getCurrent

public abstract T getCurrent()

The current resource collection.

Returns:

The current resoure collection.

hasValue

public abstract boolean hasValue()

Gets whether the current result collection has a value or not. This indicates if the collection has been fully enumerated or not.

Returns:

A flag indicating whether the current result collection has a value or not.

isFirstPage

public abstract boolean isFirstPage()

Gets whether the current result collection is the first page of results or not.

Returns:

A flag indicating whether or not the result collect is the fist page of results or not.

isLastPage

public abstract boolean isLastPage()

Gets whether the current result collection is the last page of results or not.

Returns:

A flag indicating whether the current result collection is the last page of results or not.

next

public abstract void next()

Retrieves the next result set.

next

public abstract void next(IRequestContext context)

Retrieves the next result set.

Parameters:

context - An optional request context. If not provided, the context associated with the partner operations will be used.

previous

public abstract void previous()

Retrieves the previous result set.

previous

public abstract void previous(IRequestContext context)

Retrieves the previous result set.

Parameters:

context - An optional request context. If not provided, the context associated with the partner operations will be used.