FileDocCategorySizeDatePackage
QueryParams.javaAPI DocAndroid 1.5 API5761Wed May 06 22:41:16 BST 2009com.google.wireless.gdata.client

QueryParams

public abstract class QueryParams extends Object
Class for specifying parameters and constraints for a GData feed. These are used to modify the feed URL and add querystring parameters to the feed URL. Note that if an entry ID has been set, no other query params can be set.
see
QueryParams#generateQueryUrl(String)

Fields Summary
public static final String
QUERY_PARAM
Param name constant for a search query.
public static final String
AUTHOR_PARAM
Param name constant for filtering by author.
public static final String
ALT_PARAM
Param name constant for alternate representations of GData.
public static final String
ALT_RSS
public static final String
ALT_JSON
public static final String
UPDATED_MIN_PARAM
Param name constant for the updated min.
public static final String
UPDATED_MAX_PARAM
Param name constant for the updated max.
public static final String
PUBLISHED_MIN_PARAM
Param name constant for the published min.
public static final String
PUBLISHED_MAX_PARAM
Param name constant for the published max.
public static final String
START_INDEX_PARAM
Param name constant for the start index for results.
public static final String
MAX_RESULTS_PARAM
Param name constant for the max number of results that should be fetched.
private String
entryId
Constructors Summary
public QueryParams()
Creates a new empty QueryParams.


              
      
    
Methods Summary
public abstract voidclear()
Clears everything in this QueryParams.

public abstract java.lang.StringgenerateQueryUrl(java.lang.String feedUrl)
Generates the url that should be used to query a GData feed.

param
feedUrl The original feed URL.
return
The URL that should be used to query the GData feed.

public java.lang.StringgetAlt()

return
the alt

        return getParamValue(ALT_PARAM);
    
public java.lang.StringgetAuthor()

return
the author

        return getParamValue(AUTHOR_PARAM);
    
public java.lang.StringgetEntryId()

return
the entryId

        return entryId;
    
public java.lang.StringgetMaxResults()

return
the maxResults

        return getParamValue(MAX_RESULTS_PARAM);
    
public abstract java.lang.StringgetParamValue(java.lang.String param)
Gets a parameter value from this QueryParams.

param
param The parameter name.
return
The parameter value. Returns null if the parameter is not defined in this QueryParams.

public java.lang.StringgetPublishedMax()

return
the publishedMax

        return getParamValue(PUBLISHED_MAX_PARAM);
    
public java.lang.StringgetPublishedMin()

return
the publishedMin

        return getParamValue(PUBLISHED_MIN_PARAM);
    
public java.lang.StringgetQuery()

return
the query

        return getParamValue(QUERY_PARAM);
    
public java.lang.StringgetStartIndex()

return
the startIndex

        return getParamValue(START_INDEX_PARAM);
    
public java.lang.StringgetUpdatedMax()

return
the updatedMax

        return getParamValue(UPDATED_MAX_PARAM);
    
public java.lang.StringgetUpdatedMin()

return
the updatedMin

        return getParamValue(UPDATED_MIN_PARAM);
    
public voidsetAlt(java.lang.String alt)

param
alt the alt to set

        setParamValue(ALT_PARAM, alt);
    
public voidsetAuthor(java.lang.String author)

param
author the author to set

        setParamValue(AUTHOR_PARAM, author);
    
public voidsetEntryId(java.lang.String entryId)

param
entryId the entryId to set

        this.entryId = entryId;
    
public voidsetMaxResults(java.lang.String maxResults)

param
maxResults the maxResults to set

        setParamValue(MAX_RESULTS_PARAM, maxResults);
    
public abstract voidsetParamValue(java.lang.String param, java.lang.String value)
Sets a parameter value in this QueryParams.

param
param The parameter name.
param
value The parameter value.

public voidsetPublishedMax(java.lang.String publishedMax)

param
publishedMax the publishedMax to set

        setParamValue(PUBLISHED_MAX_PARAM, publishedMax);
    
public voidsetPublishedMin(java.lang.String publishedMin)

param
publishedMin the publishedMin to set

        setParamValue(PUBLISHED_MIN_PARAM, publishedMin);
    
public voidsetQuery(java.lang.String query)

param
query the query to set

        setParamValue(QUERY_PARAM, query);
    
public voidsetStartIndex(java.lang.String startIndex)

param
startIndex the startIndex to set

        setParamValue(START_INDEX_PARAM, startIndex);
    
public voidsetUpdatedMax(java.lang.String updatedMax)

param
updatedMax the updatedMax to set

        setParamValue(UPDATED_MAX_PARAM, updatedMax);
    
public voidsetUpdatedMin(java.lang.String updatedMin)

param
updatedMin the updatedMin to set

        setParamValue(UPDATED_MIN_PARAM, updatedMin);