com.atlassian.marketplace.client.api

Class ProductQuery

java.lang.Object

com.atlassian.marketplace.client.api.ProductQuery

All Implemented Interfaces:

QueryProperties.ApplicationCriteria, QueryProperties.Bounds, QueryProperties.Cost, QueryProperties.Hosting, QueryProperties.WithVersion

public final class ProductQuery
extends Object
implements QueryProperties.ApplicationCriteria, QueryProperties.Bounds, QueryProperties.Cost, QueryProperties.Hosting, QueryProperties.WithVersion

Encapsulates search parameters that can be passed to Products.find(ProductQuery).

Since:

2.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProductQuery.Builder Builder class for ProductQuery.

Method Summary

Methods

Modifier and Type	Method and Description
static ProductQuery	any() Returns a ProductQuery with no criteria, which will match any available product.
static ProductQuery.Builder	builder() Returns a new ProductQuery.Builder for constructing a ProductQuery.
static ProductQuery.Builder	builder(ProductQuery query) Returns a new ProductQuery.Builder for constructing a ProductQuery based on an existing ProductQuery.
boolean	equals(Object other)
com.atlassian.fugue.Option<Integer>	getAppBuildNumber() The application build number, if any, that the client is using to restrict the query results.
com.atlassian.fugue.Option<ApplicationKey>	getApplication() The key of the application, if any, that the client is using to restrict the query results.
QueryBounds	getBounds() The offset/limit parameters attached to this query.
com.atlassian.fugue.Option<Cost>	getCost() The Cost filter, if any, that the client is using to restrict the query results.
com.atlassian.fugue.Option<HostingType>	getHosting() The hosting type that the client is using to restrict the query, if any.
int	hashCode()
boolean	isWithVersion() True if the client is requesting version-level detail in the result set.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

builder

public static ProductQuery.Builder builder()

Returns a new ProductQuery.Builder for constructing a ProductQuery.

any

public static ProductQuery any()

Returns a ProductQuery with no criteria, which will match any available product.

builder

public static ProductQuery.Builder builder(ProductQuery query)

Returns a new ProductQuery.Builder for constructing a ProductQuery based on an existing ProductQuery.

getApplication

public com.atlassian.fugue.Option<ApplicationKey> getApplication()

Description copied from interface: QueryProperties.ApplicationCriteria

The key of the application, if any, that the client is using to restrict the query results.

Specified by:

getApplication in interface QueryProperties.ApplicationCriteria

See Also:

QueryBuilderProperties.ApplicationCriteria.application(Option)

getAppBuildNumber

public com.atlassian.fugue.Option<Integer> getAppBuildNumber()

Description copied from interface: QueryProperties.ApplicationCriteria

The application build number, if any, that the client is using to restrict the query results.

Specified by:

getAppBuildNumber in interface QueryProperties.ApplicationCriteria

See Also:

QueryBuilderProperties.ApplicationCriteria.appBuildNumber(Option)

getCost

public com.atlassian.fugue.Option<Cost> getCost()

Description copied from interface: QueryProperties.Cost

The Cost filter, if any, that the client is using to restrict the query results.

Specified by:

getCost in interface QueryProperties.Cost

See Also:

QueryBuilderProperties.Cost.cost(Option)

getHosting

public com.atlassian.fugue.Option<HostingType> getHosting()

Description copied from interface: QueryProperties.Hosting

The hosting type that the client is using to restrict the query, if any.

Specified by:

getHosting in interface QueryProperties.Hosting

See Also:

QueryBuilderProperties.Hosting.hosting(Option)

isWithVersion

public boolean isWithVersion()

Description copied from interface: QueryProperties.WithVersion

True if the client is requesting version-level detail in the result set.

Specified by:

isWithVersion in interface QueryProperties.WithVersion

See Also:

QueryBuilderProperties.WithVersion.withVersion(boolean)

getBounds

public QueryBounds getBounds()

Description copied from interface: QueryProperties.Bounds

The offset/limit parameters attached to this query.

Specified by:

getBounds in interface QueryProperties.Bounds

See Also:

QueryBuilderProperties.Bounds.bounds(QueryBounds)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object