CommcareFixtureService

public interface CommcareFixtureService

A service to perform queries against CommCareHQ fixture APIs.

Methods

getCommcareFixtureById

CommcareFixture getCommcareFixtureById(String id, String configName)

Queries CommCareHQ for a specific fixture

Parameters:
  • id – the id of the fixture to retrieve.
  • configName – the name of the configuration used for connecting to CommcareHQ, null means default configuration
Returns:

the CommcareFixture object representing the information about the fixture from CommCareHQ, or null if that fixture did not exist on that domain.

getCommcareFixtureById

CommcareFixture getCommcareFixtureById(String id)

Same as getCommcareFixtureById but uses default configuration.

getFixtures

List<CommcareFixture> getFixtures(Integer pageSize, Integer pageNumber, String configName)

Queries CommCareHQ for a list of fixtures(located on the given page) on the configured domain.

Parameters:
  • pageSize – the size of the page
  • pageNumber – the number of the page
  • configName – the name of the configuration used for connecting to CommcareHQ, null means default configuration
Returns:

the list of CommcareFixture that represent the information about each fixture located on the given page from CommCareHQ

getFixtures

List<CommcareFixture> getFixtures(Integer pageSize, Integer pageNumber)

Same as getFixtures but uses default configuration.