com.frevvo.forms.client
Class SubmissionQuery

java.lang.Object
  com.google.gdata.client.Query
      com.frevvo.forms.client.SubmissionQuery

public class SubmissionQuery
extends com.google.gdata.client.Query

Query for submissions supporting queries by categories, author, form name, updated date, revision, custom keys and/or by control values if there a configured to be saved.

• Query submissions by kind: FORM or FLOW

  The following code snippet show how to query FORM submissions only

   URL subsUrl = formsService.getFeedUrl(SubmissionFeed.class);
   SubmissionQuery subsQuery = new SubmissionQuery(subsUrl);
   CategoryFilter f = new CategoryFilter();
   Category flowCat = new Category(FormsService.FREVVO_KIND_SCHEME, FormsService.SCHEME_KIND_FORM);
   f.addCategory(flowCat);
   subsQuery.addCategoryFilter(f);
   SubmissionFeed subs = formsService.getFeed(subsQuery, SubmissionFeed.class);
   

  The following code snippet show how to query FLOW submissions only

   URL subsUrl = formsService.getFeedUrl(SubmissionFeed.class);
   SubmissionQuery subsQuery = new SubmissionQuery(subsUrl);
   CategoryFilter f = new CategoryFilter();
   Category flowCat = new Category(FormsService.FREVVO_KIND_SCHEME, FormsService.SCHEME_KIND_FLOW);
   f.addCategory(flowCat);
   subsQuery.addCategoryFilter(f);
   SubmissionFeed subs = formsService.getFeed(subsQuery, SubmissionFeed.class);
   

  Note that at this point adding excluded categories is not supported (CategoryFilter.addExcludedCategory(Category))

• Query submissions by state: SAVED or SUBMITTED

  The following code snippet shows how to query SAVED submissions only

   URL subsUrl = formsService.getFeedUrl(SubmissionFeed.class);
   SubmissionQuery subsQuery = new SubmissionQuery(subsUrl);
   CategoryFilter f = new CategoryFilter();
   Category flowCat = new Category(FormsService.FREVVO_STATE_SCHEME, FormsService.SCHEME_STATE_SAVED);
   f.addCategory(flowCat);
   subsQuery.addCategoryFilter(f);
   SubmissionFeed subs = formsService.getFeed(subsQuery, SubmissionFeed.class);
   

  The following code snippet shows how to query SUBMITTED submissions only

   URL subsUrl = formsService.getFeedUrl(SubmissionFeed.class);
   SubmissionQuery subsQuery = new SubmissionQuery(subsUrl);
   CategoryFilter f = new CategoryFilter();
   Category flowCat = new Category(FormsService.FREVVO_STATE_SCHEME, FormsService.SCHEME_STATE_SUBMITTED);
   f.addCategory(flowCat);
   subsQuery.addCategoryFilter(f);
   SubmissionFeed subs = formsService.getFeed(subsQuery, SubmissionFeed.class);
   

  Note that at this point adding excluded categories is not supported (CategoryFilter.addExcludedCategory(Category))

• Query submissions by last updated date

  The following code snippet shows how to query submissions between Jan 1st, 2010 and Jan 31st, 2010.

   URL subsUrl = formsService.getFeedUrl(SubmissionFeed.class);
   SubmissionQuery subsQuery = new SubmissionQuery(subsUrl);
   subsQuery.setUpdatedMin(new DateTime(new Date(2010,0,1));
   subsQuery.setUpdatedMax(new DateTime(new Date(2010,0,31));
   SubmissionFeed subs = formsService.getFeed(subsQuery, SubmissionFeed.class);
   

• Query submissions by form name

  The following code snippet shows how to query submissions for form named 'Expense Report'.

   URL subsUrl = formsService.getFeedUrl(SubmissionFeed.class);
   SubmissionQuery subsQuery = new SubmissionQuery(subsUrl);
   subsQuery.setFilter("$name eq 'Expense Report'");
   SubmissionFeed subs = formsService.getFeed(subsQuery, SubmissionFeed.class);
   

• Query submissions by key value

  The following code snippet shows how to query submissions by the key #1 mapped to the PatientId control and the key #2 mapped to the EyeColor control.

   URL subsUrl = formsService.getFeedUrl(SubmissionFeed.class);
   SubmissionQuery subsQuery = new SubmissionQuery(subsUrl);
   subsQuery.setFilter("$key1 eq 'cust-1234'", "$key2 eq 'Green");
   SubmissionFeed subs = formsService.getFeed(subsQuery, SubmissionFeed.class);
   

• Query submissions by saved control value

  The following code snippet shows how to query submissions by a saved control named PatientId.

   URL subsUrl = formsService.getFeedUrl(SubmissionFeed.class);
   SubmissionQuery subsQuery = new SubmissionQuery(subsUrl);
   subsQuery.setFilter("PatientId eq 'cust-1234'");
   SubmissionFeed subs = formsService.getFeed(subsQuery, SubmissionFeed.class);
   

• Query submissions by author

  The following code snippet shows how to query submissions by author, i.e. who submitted the form

   URL subsUrl = formsService.getFeedUrl(SubmissionFeed.class);
   SubmissionQuery subsQuery = new SubmissionQuery(subsUrl);
   subsQuery.setFilter("$author eq 'johnd'");
   SubmissionFeed subs = formsService.getFeed(subsQuery, SubmissionFeed.class);
   

• Query submissions ordered by the updated date

  The following code snippet shows how to query submissions ordered by the updated date in descending order:

   URL subsUrl = formsService.getFeedUrl(SubmissionFeed.class);
   SubmissionQuery subsQuery = new SubmissionQuery(subsUrl);
   subsQuery.setOrderBy("$updated desc");
   SubmissionFeed subs = formsService.getFeed(subsQuery, SubmissionFeed.class);
   

  And here in ascending order:

   URL subsUrl = formsService.getFeedUrl(SubmissionFeed.class);
   SubmissionQuery subsQuery = new SubmissionQuery(subsUrl);
   subsQuery.setOrderBy("$updated asc");
   SubmissionFeed subs = formsService.getFeed(subsQuery, SubmissionFeed.class);
   

• Query submissions pagination

  The following code snippet shows how to process submissions in pages of size 10 starting at 0

   URL subsUrl = formsService.getFeedUrl(SubmissionFeed.class);
   SubmissionQuery subsQuery = new SubmissionQuery(subsUrl);
   subsQuery.setStartIndex(0);
   subsQuery.setMaxResults(10);
   SubmissionFeed subs = formsService.getFeed(subsQuery, SubmissionFeed.class);
   while(subs != null){
          for(SubmissionEntry sub : subs.getEntries()){
                  // do something
          }
    subs = subs.getNext();
   }
   

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gdata.client.Query

com.google.gdata.client.Query.CategoryFilter, com.google.gdata.client.Query.CustomParameter, com.google.gdata.client.Query.ResultFormat

Field Summary

static java.lang.String	FILTER
static java.lang.String	ORDERBY

Fields inherited from class com.google.gdata.client.Query

UNDEFINED

Constructor Summary

SubmissionQuery(java.net.URL feedUrl)

Method Summary

void	addCategoryFilter(com.google.gdata.client.Query.CategoryFilter f) Unsupported at this point: categories can only be included, not excluded
java.lang.String[]	getFilter() Get the filters for this query
java.lang.String	getOrderby()
void	parseFilter(java.net.URL feedUrl)
void	parseOrderby(java.net.URL feedUrl)
void	setAuthor(java.lang.String author) Unsupported at this point
void	setFields(java.lang.String fields) Unsupported at this point
void	setFilter(java.lang.String... filter) Set the filters for this query
void	setFullTextQuery(java.lang.String query) Unsupported at this point.
void	setOrderby(java.lang.String orderby) Set the ordering of results
void	setPublishedMax(com.google.gdata.data.DateTime publishedMax) Unsupported at this point.
void	setPublishedMin(com.google.gdata.data.DateTime publishedMin) Unsupported at this point.
void	setResultFormat(com.google.gdata.client.Query.ResultFormat resultFormat) Unsupported at this point.
void	setStrict(boolean strict) Unsupported at this point.

Methods inherited from class com.google.gdata.client.Query

addCustomParameter, appendQueryParameter, getAuthor, getCategoryFilters, getCustomParameters, getCustomParameters, getFeedUrl, getFields, getFullTextQuery, getIntegerCustomParameter, getMaxResults, getPublishedMax, getPublishedMin, getQueryUri, getResultFormat, getStartIndex, getStringCustomParameter, getUpdatedMax, getUpdatedMin, getUrl, isStrict, isValidState, setIntegerCustomParameter, setMaxResults, setStartIndex, setStringCustomParameter, setUpdatedMax, setUpdatedMin

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FILTER

public static final java.lang.String FILTER

See Also:

Constant Field Values

ORDERBY

public static final java.lang.String ORDERBY

See Also:

Constant Field Values

Constructor Detail

SubmissionQuery

public SubmissionQuery(java.net.URL feedUrl)

Method Detail

parseFilter

public void parseFilter(java.net.URL feedUrl)

setFilter

public void setFilter(java.lang.String... filter)

Set the filters for this query

Parameters:

filter - Any number of filters in an 'and' composition

getFilter

public java.lang.String[] getFilter()

Get the filters for this query

Returns:

An array containing all the filters in an 'and' composition

parseOrderby

public void parseOrderby(java.net.URL feedUrl)

setOrderby

public void setOrderby(java.lang.String orderby)

Set the ordering of results

Parameters:

orderby - A string in the format {field} (asc|desc)'. For instance:

• $updated desc
• $name asc

getOrderby

public java.lang.String getOrderby()

setPublishedMax

public void setPublishedMax(com.google.gdata.data.DateTime publishedMax)

Unsupported at this point. Use setUpdatedMax() instead.

Overrides:

setPublishedMax in class com.google.gdata.client.Query

setPublishedMin

public void setPublishedMin(com.google.gdata.data.DateTime publishedMin)

Unsupported at this point. Use setUpdatedMin() instead.

Overrides:

setPublishedMin in class com.google.gdata.client.Query

setAuthor

public void setAuthor(java.lang.String author)

Unsupported at this point

Overrides:

setAuthor in class com.google.gdata.client.Query

setFullTextQuery

public void setFullTextQuery(java.lang.String query)

Unsupported at this point.

Overrides:

setFullTextQuery in class com.google.gdata.client.Query

setResultFormat

public void setResultFormat(com.google.gdata.client.Query.ResultFormat resultFormat)

Unsupported at this point.

Overrides:

setResultFormat in class com.google.gdata.client.Query

setStrict

public void setStrict(boolean strict)

Unsupported at this point. Always returning Atom xml.

Overrides:

setStrict in class com.google.gdata.client.Query

setFields

public void setFields(java.lang.String fields)

Unsupported at this point

Overrides:

setFields in class com.google.gdata.client.Query

addCategoryFilter

public void addCategoryFilter(com.google.gdata.client.Query.CategoryFilter f)

Unsupported at this point: categories can only be included, not excluded

Overrides:

addCategoryFilter in class com.google.gdata.client.Query