org.killbill.billing.entitlement.api

Interface SubscriptionApi

All Superinterfaces:

KillbillApi

public interface SubscriptionApi
extends KillbillApi

API to manage the retrieval of Subscription information.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALL_EVENTS
static int	FUTURE_EVENTS
static int	FUTURE_OR_PRESENT_EVENTS
static int	PAST_EVENTS
static int	PAST_OR_PRESENT_EVENTS
static int	PRESENT_EVENTS

Method Summary

Modifier and Type	Method and Description
void	addBlockingState(BlockingState blockingState, org.joda.time.LocalDate effectiveDate, java.lang.Iterable<PluginProperty> properties, CallContext context) Add a BlockingState The date is interpreted by the system to be in the timezone specified at the Account
SubscriptionBundle	getActiveSubscriptionBundleForExternalKey(java.lang.String externalKey, TenantContext context) Retrieves all the SubscriptionBundle for the given external key.
java.lang.Iterable<BlockingState>	getBlockingStates(java.util.UUID accountId, java.util.List<BlockingStateType> typeFilter, java.util.List<java.lang.String> svcsFilter, OrderingType orderingType, int timeFilter, TenantContext context)
SubscriptionBundle	getSubscriptionBundle(java.util.UUID bundleId, TenantContext context) Retrieves all the Subscription attached to the base entitlement.
Pagination<SubscriptionBundle>	getSubscriptionBundles(java.lang.Long offset, java.lang.Long limit, TenantContext context)
java.util.List<SubscriptionBundle>	getSubscriptionBundlesForAccountId(java.util.UUID accountId, TenantContext context) Retrieves all the SubscriptionBundle for a given account.
java.util.List<SubscriptionBundle>	getSubscriptionBundlesForAccountIdAndExternalKey(java.util.UUID accountId, java.lang.String externalKey, TenantContext context) Retrieves all the SubscriptionBundle for a given account and matching an external key.
java.util.List<SubscriptionBundle>	getSubscriptionBundlesForExternalKey(java.lang.String externalKey, TenantContext context) Returns an ordered list of all SubscriptionBundle for a given external key.
Subscription	getSubscriptionForEntitlementId(java.util.UUID entitlementId, TenantContext context) Retrieves a Subscription For the entitlementId
Pagination<SubscriptionBundle>	searchSubscriptionBundles(java.lang.String searchKey, java.lang.Long offset, java.lang.Long limit, TenantContext context) Find all SubscriptionBundle having their id, account id or external key matching the search key
void	updateExternalKey(java.util.UUID bundleId, java.lang.String newExternalKey, CallContext context) Update the externalKey for a given bundle

Field Detail

PAST_EVENTS

static final int PAST_EVENTS

See Also:

Constant Field Values

PRESENT_EVENTS

static final int PRESENT_EVENTS

See Also:

Constant Field Values

FUTURE_EVENTS

static final int FUTURE_EVENTS

See Also:

Constant Field Values

PAST_OR_PRESENT_EVENTS

static final int PAST_OR_PRESENT_EVENTS

See Also:

Constant Field Values

FUTURE_OR_PRESENT_EVENTS

static final int FUTURE_OR_PRESENT_EVENTS

See Also:

Constant Field Values

ALL_EVENTS

static final int ALL_EVENTS

See Also:

Constant Field Values

Method Detail

getSubscriptionForEntitlementId

Subscription getSubscriptionForEntitlementId(java.util.UUID entitlementId,
                                             TenantContext context)
                                      throws SubscriptionApiException

Retrieves a Subscription For the entitlementId

Parameters:

entitlementId - the id of the entitlement associated with the subscription

context - the context

Returns:

the subscription

Throws:

SubscriptionApiException - if it odes not exist

getSubscriptionBundle

SubscriptionBundle getSubscriptionBundle(java.util.UUID bundleId,
                                         TenantContext context)
                                  throws SubscriptionApiException

Retrieves all the Subscription attached to the base entitlement.

Parameters:

bundleId - the id of the bundle

context - the context

Returns:

a list of subscriptions

Throws:

SubscriptionApiException - if the baseEntitlementId does not exist.

updateExternalKey

void updateExternalKey(java.util.UUID bundleId,
                       java.lang.String newExternalKey,
                       CallContext context)
                throws EntitlementApiException

Update the externalKey for a given bundle

Parameters:

bundleId - ; bundle id

newExternalKey - : the new value for the externalKey

context - : the call context

Throws:

EntitlementApiException

getSubscriptionBundlesForAccountIdAndExternalKey

java.util.List<SubscriptionBundle> getSubscriptionBundlesForAccountIdAndExternalKey(java.util.UUID accountId,
                                                                                    java.lang.String externalKey,
                                                                                    TenantContext context)
                                                                             throws SubscriptionApiException

Retrieves all the SubscriptionBundle for a given account and matching an external key.

Parameters:

accountId - the account id

externalKey - the external key

context - the context

Returns:

a SubscriptionBundle

Throws:

SubscriptionApiException - if there is n o such object matching the account and external key

getActiveSubscriptionBundleForExternalKey

SubscriptionBundle getActiveSubscriptionBundleForExternalKey(java.lang.String externalKey,
                                                             TenantContext context)
                                                      throws SubscriptionApiException

Retrieves all the SubscriptionBundle for the given external key.

It is possible to have multiple SubscriptionBundle for a given external key in the system but only one will be active -- i.e. will contain Subscription in the active state.

Parameters:

externalKey - the external key

context - the context

Returns:

a SubscriptionBundle

Throws:

SubscriptionApiException - if there is no such object

getSubscriptionBundlesForExternalKey

java.util.List<SubscriptionBundle> getSubscriptionBundlesForExternalKey(java.lang.String externalKey,
                                                                        TenantContext context)
                                                                 throws SubscriptionApiException

Returns an ordered list of all SubscriptionBundle for a given external key.

Returns:

Throws:

SubscriptionApiException

getSubscriptionBundlesForAccountId

java.util.List<SubscriptionBundle> getSubscriptionBundlesForAccountId(java.util.UUID accountId,
                                                                      TenantContext context)
                                                               throws SubscriptionApiException

Retrieves all the SubscriptionBundle for a given account.

Parameters:

accountId - the account id

context - the context

Returns:

list of SubscriptionBundle

Throws:

SubscriptionApiException - if the account does not exist

getSubscriptionBundles

Pagination<SubscriptionBundle> getSubscriptionBundles(java.lang.Long offset,
                                                      java.lang.Long limit,
                                                      TenantContext context)

Parameters:

context - the user context

offset - the offset of the first result

limit - the maximum number of results to retrieve

Returns:

the list of SubscriptionBundle for that tenant

searchSubscriptionBundles

Pagination<SubscriptionBundle> searchSubscriptionBundles(java.lang.String searchKey,
                                                         java.lang.Long offset,
                                                         java.lang.Long limit,
                                                         TenantContext context)

Find all SubscriptionBundle having their id, account id or external key matching the search key

Parameters:

searchKey - the search key

offset - the offset of the first result

limit - the maximum number of results to retrieve

context - the user context

Returns:

the list of SubscriptionBundle matching this search key for that tenant

addBlockingState

void addBlockingState(BlockingState blockingState,
                      org.joda.time.LocalDate effectiveDate,
                      java.lang.Iterable<PluginProperty> properties,
                      CallContext context)
               throws EntitlementApiException

Add a BlockingState

The date is interpreted by the system to be in the timezone specified at the Account

Parameters:

blockingState - the blockingState to be added

effectiveDate - the date in the account time zone at which the operation should be effective, if null this is interpreted to be immediate

properties - plugin specific properties

context - the context

Throws:

EntitlementApiException - if the entitlement was not in ACTIVE state

getBlockingStates

java.lang.Iterable<BlockingState> getBlockingStates(java.util.UUID accountId,
                                                    java.util.List<BlockingStateType> typeFilter,
                                                    java.util.List<java.lang.String> svcsFilter,
                                                    OrderingType orderingType,
                                                    int timeFilter,
                                                    TenantContext context)
                                             throws EntitlementApiException

Parameters:

accountId - the account id

typeFilter - the list of BlockingStateType filters. All types are returned if null or empty.

svcsFilter - the list of service filters. All services are returned if null or empty.

orderingType - the ordering direction, that is ASCENDING or DESCENDING

timeFilter - the filtering types constructed as a bitwise operation

context - the user context

Returns:

the ordered list of BlockingState

Throws:

EntitlementApiException - if the account is invalid.