Package com.microsoft.store.partnercenter.enumerators

Interface IResourceCollectionEnumerator<T extends ResourceBaseWithLinks<StandardResourceCollectionLinks>>

All Known Implementing Classes:
BaseResourceCollectionEnumerator, IndexBasedCollectionEnumerator
public interface IResourceCollectionEnumerator<T extends ResourceBaseWithLinks<StandardResourceCollectionLinks>>
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 Description
    T getCurrent()
    The current resource collection.
    boolean hasValue()
    Gets whether the current result collection has a value or not.
    boolean isFirstPage()
    Gets whether the current result collection is the first page of results or not.
    boolean isLastPage()
    Gets whether the current result collection is the last page of results or not.
    void next()
    Retrieves the next result set.
    void next​(IRequestContext context)
    Retrieves the next result set.
    void previous()
    Retrieves the previous result set.
    void previous​(IRequestContext context)
    Retrieves the previous result set.

  • Method Details

    • isFirstPage

      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

      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.

    • hasValue

      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.

    • getCurrent

      T getCurrent()
      The current resource collection.
      Returns:
      The current resoure collection.

    • next

      void next()
      Retrieves the next result set.

    • next

      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

      void previous()
      Retrieves the previous result set.

    • previous

      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.