interface RestfulDataProviderEFQInterface in RESTful 7

@file Contains \RestfulDataProviderEFQInterface

Hierarchy

• interface \RestfulDataProviderEFQInterface

File

plugins/restful/RestfulDataProviderEFQInterface.php, line 8

Contains \RestfulDataProviderEFQInterface

interface RestfulDataProviderEFQInterface {

  /**
   * Prepare a query for RestfulEntityBase::getList().
   *
   * @return EntityFieldQuery
   *   The EntityFieldQuery object.
   */
  public function getQueryForList();

  /**
   * Prepare a query for RestfulEntityBase::getTotalCount().
   *
   * @return EntityFieldQuery
   *   The EntityFieldQuery object.
   *
   * @throws RestfulBadRequestException
   */
  public function getQueryCount();

  /**
   * Get the total count of entities that match certain request.
   *
   * @return int
   *   The total number of results without including pagination.
   */
  public function getTotalCount();

}

Members

Name	Modifiers	Type	Description	Overrides
RestfulDataProviderEFQInterface::getQueryCount	public	function	Prepare a query for RestfulEntityBase::getTotalCount().	1
RestfulDataProviderEFQInterface::getQueryForList	public	function	Prepare a query for RestfulEntityBase::getList().	1
RestfulDataProviderEFQInterface::getTotalCount	public	function	Get the total count of entities that match certain request.	1