com.atlassian.marketplace.client.api

Interface Products

public interface Products

Starting point for all resources that return product information. Use MarketplaceClient.products() to access this API.

A "product", in this context, is an Atlassian software package that can be either purchased separately or installed into a platform instance, such as JIRA Service Desk. These are called "applications" in the user-facing UI, but that term is already used for a different purpose in the Marketplace model (see Applications).

Since:

2.0.0

Method Summary

Methods

Modifier and Type	Method and Description
Page<Product>	find(ProductQuery query) Returns a list of products.
com.atlassian.fugue.Option<Product>	getByKey(String productKey, ProductQuery query) Queries a single product.
com.atlassian.fugue.Option<ProductVersion>	getVersion(String productKey, ProductVersionSpecifier versionQuery) Queries a specific version of a product.

Method Detail

getByKey

com.atlassian.fugue.Option<Product> getByKey(String productKey,
                                           ProductQuery query)
                                             throws MpacException

Queries a single product.

Parameters:

productKey - the product's unique key

query - a ProductQuery which may contain criteria to limit the search, such as the compatible application version; use ProductQuery.any() if there are no additional criteria

Returns:

the product information, or Option.none() if there is no match

Throws:

MpacException - if the server was unavailable or returned an error

getVersion

com.atlassian.fugue.Option<ProductVersion> getVersion(String productKey,
                                                    ProductVersionSpecifier versionQuery)
                                                      throws MpacException

Queries a specific version of a product.

Parameters:

productKey - the product's unique key

versionQuery - search criteria for identifying a single version

Returns:

the product version information, or Option.none() if there is no match

Throws:

MpacException - if the server was unavailable or returned an error

find

Page<Product> find(ProductQuery query)
                   throws MpacException

Returns a list of products.

Parameters:

query - a ProductQuery

Returns:

the available products

Throws:

MpacException - if the server was unavailable or returned an error