public class

PortfolioQuery

extends Query

java.lang.Object
↳	com.google.gdata.client.Query
	↳	com.google.gdata.client.finance.PortfolioQuery

Class Overview

Describes a query for the feed of all the user's portfolios.

Summary

[Expand]

Inherited Constants

From class com.google.gdata.client.Query

Fields
private Boolean	includeReturns	Flag indicating whether returns and performance stats should be included in the portfolio and position feed entries.
private Boolean	inlinePositions	Flag to inline positions under the portfolio feed.

[Expand]

Inherited Fields

From class com.google.gdata.client.Query

private String	author	Author name or e-mail address for matched entries.
private List<Query.CategoryFilter>	categoryFilters	The list of category filters associate with the query.
private List<Query.CustomParameter>	customParameters	The list of custom parameters associated with the query.
private URL	feedUrl	Base feed URL against which the query will be applied.
private String	fields	Fields partial selection query parameter
private int	maxResults	The maximum number of results to return for the query.
private DateTime	publishedMax	Maximum published timestamp for matched entries.
private DateTime	publishedMin	Minimum published timestamp for matched entries.
private String	queryString	Full-text search query string.
private Query.ResultFormat	resultFormat	The expected result format for the query.
private int	startIndex	The start index for query results.
private boolean	strict	The strictness of the query parameter parsing on the server.
private DateTime	updatedMax	Maximum updated timestamp for matched entries.
private DateTime	updatedMin	Minimum updated timestamp for matched entries.

Public Constructors
	PortfolioQuery(URL feedUrl) Constructs a new query object that targets a feed.

Public Methods
Boolean	getIncludeReturns() Returns the flag indicating whether returns and performance stats should be included in the portfolio and position feed entries.
Boolean	getInlinePositions() Returns the flag to inline positions under the portfolio feed.
void	setIncludeReturns(Boolean includeReturns) Sets the flag indicating whether returns and performance stats should be included in the portfolio and position feed entries.
void	setInlinePositions(Boolean inlinePositions) Sets the flag to inline positions under the portfolio feed.

[Expand]

Inherited Methods

From class com.google.gdata.client.Query

void	addCategoryFilter(Query.CategoryFilter categoryFilter) Adds a new CategoryFilter to the query.
void	addCustomParameter(Query.CustomParameter customParameter) Adds a new CustomParameter.
void	appendQueryParameter(StringBuilder queryBuf, String paramName, String paramValue) Appends specified query (parameter, value) to provided query URL buffer.
String	getAuthor() Returns the author name or email address used for the query.
List<Query.CategoryFilter>	getCategoryFilters() Returns the current list of CategoryFilters associated with the query.
List<Query.CustomParameter>	getCustomParameters() Returns the list of custom parameters.
List<Query.CustomParameter>	getCustomParameters(String name) Returns the list of custom parameters that match a specified name.
URL	getFeedUrl() Returns the feed URL of this query.
String	getFields() Returns the fields query string that will be used for the query.
String	getFullTextQuery() Returns the full text query string that will be used for the query.
final Integer	getIntegerCustomParameter(String name) Gets an existing Integer custom paramter, with null signifying that the parameter is not specified or not an integer.
int	getMaxResults() Returns the maximum number of results to return for the query, or `UNDEFINED` if max results has not been set.
DateTime	getPublishedMax() Returns the maximum published timestamp used for this query.
DateTime	getPublishedMin() Returns the minimum published timestamp used for this query.
URI	getQueryUri() Returns the relative query URI that represents only the query parameters without any components related to the target feed.
Query.ResultFormat	getResultFormat() Returns the query result format.
int	getStartIndex() Returns the current start index value for the query, or `UNDEFINED` if start index has not been set.
final String	getStringCustomParameter(String name) Gets an existing String custom parameter, with null signifying that the parameter is not specified.
DateTime	getUpdatedMax() Returns the maximum updated timestamp used for this query.
DateTime	getUpdatedMin() Returns the minimum updated timestamp used for this query.
URL	getUrl() Returns the Query URL that encapsulates the current state of this query object.
boolean	isStrict() Returns the strictness setting for query parameter parsing on the server.
boolean	isValidState() Check if current query state is supported.
void	setAuthor(String author) Sets the author name or email address used for the query.
void	setFields(String fields) Sets the "fields" partial selection query parameter.
void	setFullTextQuery(String query) Sets the full text query string that will be used for the query.
final void	setIntegerCustomParameter(String name, Integer value) Sets an integer custom paramter, with null signifying to clear the parameter.
void	setMaxResults(int maxResults) Sets the maximum number of results to return for the query.
void	setPublishedMax(DateTime publishedMax) Sets the maximum published timestamp used for the query.
void	setPublishedMin(DateTime publishedMin) Sets the minimum published timestamp used for the query.
void	setResultFormat(Query.ResultFormat resultFormat) Sets the expected query result format.
void	setStartIndex(int startIndex) Sets the start index for query results.
void	setStrict(boolean strict) Sets the strictness of parameter parsing.
final void	setStringCustomParameter(String name, String value) Sets a string custom parameter, with null signifying to clear the parameter.
void	setUpdatedMax(DateTime updatedMax) Sets the maximum updated timestamp used for the query.
void	setUpdatedMin(DateTime updatedMin) Sets the minimum updated timestamp used for the query.

From class java.lang.Object

Fields

private Boolean includeReturns

Flag indicating whether returns and performance stats should be included in the portfolio and position feed entries.

private Boolean inlinePositions

Flag to inline positions under the portfolio feed.

Public Constructors

public PortfolioQuery (URL feedUrl)

Constructs a new query object that targets a feed. The initial state of the query contains no parameters, meaning all entries in the feed would be returned if the query was executed immediately after construction.

Parameters

feedUrl	The URL of the feed against which queries will be executed.

Public Methods

public Boolean getIncludeReturns ()

Returns the flag indicating whether returns and performance stats should be included in the portfolio and position feed entries.

Returns

flag indicating whether returns and performance stats should be included in the portfolio and position feed entries.

public Boolean getInlinePositions ()

Returns the flag to inline positions under the portfolio feed.

Returns

flag to inline positions under the portfolio feed.

public void setIncludeReturns (Boolean includeReturns)

Sets the flag indicating whether returns and performance stats should be included in the portfolio and position feed entries.

Parameters

includeReturns	Flag indicating whether returns and performance stats should be included in the portfolio and position feed entries or `null` to reset this parameter to default value `false`.

public void setInlinePositions (Boolean inlinePositions)

Sets the flag to inline positions under the portfolio feed.

Parameters

inlinePositions	Flag to inline positions under the portfolio feed or `null` to reset this parameter to default value `false`.

Classes

PortfolioQuery

Class Overview

Summary

Fields

private Boolean includeReturns

private Boolean inlinePositions

Public Constructors

public PortfolioQuery (URL feedUrl)

Parameters

Public Methods

public Boolean getIncludeReturns ()

Returns

public Boolean getInlinePositions ()

Returns

public void setIncludeReturns (Boolean includeReturns)

Parameters

public void setInlinePositions (Boolean inlinePositions)

Parameters