org.odata4j.producer.CollectionResponse Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of odata4j-core

The newest version!

package org.odata4j.producer;

import org.odata4j.core.OCollection;
import org.odata4j.core.OObject;
import org.odata4j.edm.EdmEntitySet;

/**
 * An CollectionResponse is a response to a client request expecting a collection of OData objects.
 *
 * The {@link Responses} static factory class can be used to create CollectionResponse instances.
 */
public interface CollectionResponse extends BaseResponse {

  /**
  * Gets the entity-set for the entities if the collection is a collection of entities.
  *
  * @return the entity-set for the entities
  */
  EdmEntitySet getEntitySet();

  OCollection getCollection();

  String getCollectionName();

  /**
   * Gets the inline-count value, if applicable.
   *
   * @return the inline-count value, if applicable
   */
  Integer getInlineCount();

  /**
   * Gets the continuation token to use on a subsequent request, if applicable.
   *
   * @return a continuation token, if applicable
   */
  String getSkipToken();

}