com.atlassian.marketplace.client.api

Interface LicenseTypes

public interface LicenseTypes

Starting point for all resources that return software license type information. Use MarketplaceClient.licenseTypes() to access this API.

Since:

2.0.0

Method Summary

Methods

Modifier and Type	Method and Description
Iterable<LicenseType>	getAllLicenseTypes() Returns all of the available license types.
com.atlassian.fugue.Option<LicenseType>	getByKey(String licenseKey) Searches for a license type by its "key" property - for instance, "gpl" or "commercial".

Method Detail

getAllLicenseTypes

Iterable<LicenseType> getAllLicenseTypes()
                                         throws MpacException

Returns all of the available license types.

Throws:

MpacException - if the server was unavailable or returned an error

getByKey

com.atlassian.fugue.Option<LicenseType> getByKey(String licenseKey)
                                                 throws MpacException

Searches for a license type by its "key" property - for instance, "gpl" or "commercial". The resource URIs for license types may change in the future, but their keys will not change.

Parameters:

licenseKey - the key of the desired license type

Returns:

the license type object, or Option.none() if no such license type exists

Throws:

MpacException - if the server was unavailable or returned an error