FormListRequest¶

public class FormListRequest implements Serializable ¶: Represents a request for a form list to the Commcare HQ.

Methods¶

addQueryParams¶

public void addQueryParams(URIBuilder uriBuilder)¶

Adds the params for this request to the provided. Allows to easily add params for this query to a Commcare url.

Parameters:	uriBuilder – the uri builder that should be used

getAppVersion¶

public String getAppVersion()¶

Returns:	the exact version of the CommCare application used to submit the form

getPageNumber¶

public Integer getPageNumber()¶

Returns:	the number of the page to fetch

getPageSize¶

public Integer getPageSize()¶

Returns:	the size of the page to fetch

getReceivedOnEnd¶

public DateTime getReceivedOnEnd()¶

Returns:	the end boundary for the received on datetime field

getReceivedOnStart¶

public DateTime getReceivedOnStart()¶

Returns:	the starting boundary for the received on datetime field

getXmlns¶

public String getXmlns()¶

Returns the form XML namespace for this query. (optional) You can find this for any given form by going to your form -> Advanced -> View (Source xml) and look for the address in the header of your xform. It is also in the raw xml of any submitted form.

Returns:	the xmlns

isIncludeArchived¶

public Boolean isIncludeArchived()¶

Returns:	true if archived forms should be returned, false otherwise

setAppVersion¶

public void setAppVersion(String appVersion)¶

Parameters:	appVersion – the exact version of the CommCare application used to submit the form

setIncludeArchived¶

public void setIncludeArchived(Boolean includeArchived)¶

Parameters:	includeArchived – true if archived forms should be returned, false otherwise

setPageNumber¶

public void setPageNumber(Integer pageNumber)¶

Parameters:	pageNumber – the number of the page to fetch

setPageSize¶

public void setPageSize(Integer pageSize)¶

Parameters:	pageSize – the size of the page to fetch

setReceivedOnEnd¶

public void setReceivedOnEnd(DateTime receivedOnEnd)¶

Parameters:	receivedOnEnd – the end boundary for the received on datetime field

setReceivedOnStart¶

public void setReceivedOnStart(DateTime receivedOnStart)¶

Parameters:	receivedOnStart – the starting boundary for the received on datetime field

setXmlns¶

public void setXmlns(String xmlns)¶

Sets the form XML namespace for this query. (optional) You can find this for any given form by going to your form -> Advanced -> View (Source xml) and look for the address in the header of your xform. It is also in the raw xml of any submitted form.

Parameters:	xmlns – the xmlns