com.atlassian.marketplace.client.api

Class VendorQuery

java.lang.Object

com.atlassian.marketplace.client.api.VendorQuery

All Implemented Interfaces:

QueryProperties.Bounds

public final class VendorQuery
extends Object
implements QueryProperties.Bounds

Encapsulates search parameters that can be passed to Vendors to determine what subset of vendors you are interested in. Besides the usual QueryBounds parameters, you can specify whether to query all vendors (the default) or only the vendors that are associated with the current authenticated user.

Since:

2.0.0

Nested Class Summary

Nested Classes

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

Method Summary

Methods

Modifier and Type	Method and Description
static VendorQuery	any() Returns a VendorQuery with default criteria.
static VendorQuery.Builder	builder() Returns a new VendorQuery.Builder for constructing a VendorQuery.
static VendorQuery.Builder	builder(VendorQuery query) Returns a new VendorQuery.Builder for constructing a VendorQuery based on an existing VendorQuery.
boolean	equals(Object other)
QueryBounds	getBounds() The offset/limit parameters attached to this query.
int	hashCode()
boolean	isForThisUserOnly() True if the client is querying only the list of vendors that are associated with the current authenticated user.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static VendorQuery.Builder builder()

Returns a new VendorQuery.Builder for constructing a VendorQuery.

any

public static VendorQuery any()

Returns a VendorQuery with default criteria.

builder

public static VendorQuery.Builder builder(VendorQuery query)

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

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)

isForThisUserOnly

public boolean isForThisUserOnly()

True if the client is querying only the list of vendors that are associated with the current authenticated user.

See Also:

VendorQuery.Builder.forThisUserOnly(boolean)

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