| Modifier and Type | Method and Description |
|---|---|
Account |
AccountUserApi.getAccountById(UUID accountId,
TenantContext context) |
Account |
AccountUserApi.getAccountByKey(String key,
TenantContext context)
Retrieves an account by specifying its external key.
|
Pagination<Account> |
AccountUserApi.getAccounts(Long offset,
Long limit,
TenantContext context) |
List<AccountEmail> |
AccountUserApi.getEmails(UUID accountId,
TenantContext context) |
UUID |
AccountUserApi.getIdFromKey(String externalKey,
TenantContext context) |
Pagination<Account> |
AccountUserApi.searchAccounts(String searchKey,
Long offset,
Long limit,
TenantContext context)
Find all accounts having their name, email, external_key or company_name matching the search key
|
| Modifier and Type | Method and Description |
|---|---|
Catalog |
CatalogUserApi.getCatalog(String catalogName,
TenantContext context)
Retrieves the multi versioned catalog.
|
StaticCatalog |
CatalogUserApi.getCurrentCatalog(String catalogName,
TenantContext context)
Retrieves the current catalog
|
| Modifier and Type | Method and Description |
|---|---|
SubscriptionBundle |
SubscriptionApi.getActiveSubscriptionBundleForExternalKey(String externalKey,
TenantContext context)
Retrieves all the
SubscriptionBundle for the given external key. |
List<Entitlement> |
EntitlementApi.getAllEntitlementsForAccountId(UUID accountId,
TenantContext context)
Retrieves all the
Entitlement for a given account. |
List<Entitlement> |
EntitlementApi.getAllEntitlementsForAccountIdAndExternalKey(UUID accountId,
String externalKey,
TenantContext context)
Retrieves all the
Entitlement for a given account and matching an external key. |
List<Entitlement> |
EntitlementApi.getAllEntitlementsForBundle(UUID bundleId,
TenantContext context)
Retrieves all the
Entitlement attached to the base entitlement. |
Iterable<BlockingState> |
SubscriptionApi.getBlockingStates(UUID accountId,
List<BlockingStateType> typeFilter,
List<String> svcsFilter,
OrderingType orderingType,
int timeFilter,
TenantContext context) |
List<EntitlementAOStatusDryRun> |
EntitlementApi.getDryRunStatusForChange(UUID bundleId,
String targetProductName,
org.joda.time.LocalDate effectiveDate,
TenantContext context)
Simulate a change of product for the BP on that bundle and return the effect it would have on the existing ADD_ON-- if any.
|
Entitlement |
EntitlementApi.getEntitlementForId(UUID id,
TenantContext context)
Retrieves an
Entitlement using its id. |
SubscriptionBundle |
SubscriptionApi.getSubscriptionBundle(UUID bundleId,
TenantContext context)
Retrieves all the
Subscription attached to the base entitlement. |
Pagination<SubscriptionBundle> |
SubscriptionApi.getSubscriptionBundles(Long offset,
Long limit,
TenantContext context) |
List<SubscriptionBundle> |
SubscriptionApi.getSubscriptionBundlesForAccountId(UUID accountId,
TenantContext context)
Retrieves all the
SubscriptionBundle for a given account. |
List<SubscriptionBundle> |
SubscriptionApi.getSubscriptionBundlesForAccountIdAndExternalKey(UUID accountId,
String externalKey,
TenantContext context)
Retrieves all the
SubscriptionBundle for a given account and matching an external key. |
List<SubscriptionBundle> |
SubscriptionApi.getSubscriptionBundlesForExternalKey(String externalKey,
TenantContext context)
Returns an ordered list of all
SubscriptionBundle for a given external key. |
Subscription |
SubscriptionApi.getSubscriptionForEntitlementId(UUID entitlementId,
TenantContext context)
Retrieves a
Subscription For the entitlementId |
Pagination<SubscriptionBundle> |
SubscriptionApi.searchSubscriptionBundles(String searchKey,
Long offset,
Long limit,
TenantContext context)
Find all
SubscriptionBundle having their id, account id or external key matching the search key |
| Modifier and Type | Method and Description |
|---|---|
BigDecimal |
InvoiceUserApi.getAccountBalance(UUID accountId,
TenantContext context)
Retrieve the account balance.
|
BigDecimal |
InvoiceUserApi.getAccountCBA(UUID accountId,
TenantContext context)
Retrieve the account CBA.
|
InvoiceItem |
InvoiceUserApi.getCreditById(UUID creditId,
TenantContext context)
Retrieve a credit by id.
|
InvoiceItem |
InvoiceUserApi.getExternalChargeById(UUID externalChargeId,
TenantContext context)
Retrieve an external charge by id.
|
Invoice |
InvoiceUserApi.getInvoice(UUID invoiceId,
TenantContext context)
Retrieve an invoice by id.
|
String |
InvoiceUserApi.getInvoiceAsHTML(UUID invoiceId,
TenantContext context)
Retrieve the invoice formatted in HTML.
|
Invoice |
InvoiceUserApi.getInvoiceByNumber(Integer number,
TenantContext context)
Retrieve an invoice by invoice number.
|
Invoice |
InvoiceUserApi.getInvoiceByPayment(UUID paymentId,
TenantContext context)
Get all invoices for a given payment.
|
List<InvoicePayment> |
InvoicePaymentApi.getInvoicePayments(UUID paymentId,
TenantContext context) |
List<InvoicePayment> |
InvoicePaymentApi.getInvoicePaymentsByAccount(UUID accountId,
TenantContext context) |
Pagination<Invoice> |
InvoiceUserApi.getInvoices(Long offset,
Long limit,
TenantContext context) |
List<Invoice> |
InvoiceUserApi.getInvoicesByAccount(UUID accountId,
boolean includesMigrated,
TenantContext context)
Get all invoices for a given account.
|
List<Invoice> |
InvoiceUserApi.getInvoicesByAccount(UUID accountId,
org.joda.time.LocalDate fromDate,
TenantContext context)
Find invoices from a given day, for a given account.
|
Collection<Invoice> |
InvoiceUserApi.getUnpaidInvoicesByAccountId(UUID accountId,
org.joda.time.LocalDate upToDate,
TenantContext context)
Find unpaid invoices for a given account, up to a given day.
|
Pagination<Invoice> |
InvoiceUserApi.searchInvoices(String searchKey,
Long offset,
Long limit,
TenantContext context)
Find all invoices having their id, number, account id or currency matching the search key
|
| Modifier and Type | Method and Description |
|---|---|
OverdueConfig |
OverdueApi.getOverdueConfig(TenantContext context) |
OverdueState |
OverdueApi.getOverdueStateFor(UUID accountId,
TenantContext context) |
| Modifier and Type | Method and Description |
|---|---|
List<PaymentMethod> |
PaymentApi.getAccountPaymentMethods(UUID accountId,
boolean withPluginInfo,
Iterable<PluginProperty> properties,
TenantContext context) |
List<Payment> |
PaymentApi.getAccountPayments(UUID accountId,
boolean withPluginInfo,
Iterable<PluginProperty> properties,
TenantContext context) |
Payment |
PaymentApi.getPayment(UUID paymentId,
boolean withPluginInfo,
Iterable<PluginProperty> properties,
TenantContext context) |
Payment |
PaymentApi.getPaymentByExternalKey(String paymentExternalKey,
boolean withPluginInfo,
Iterable<PluginProperty> properties,
TenantContext context) |
PaymentMethod |
PaymentApi.getPaymentMethodByExternalKey(String paymentMethodExternalKey,
boolean includedInactive,
boolean withPluginInfo,
Iterable<PluginProperty> properties,
TenantContext context) |
PaymentMethod |
PaymentApi.getPaymentMethodById(UUID paymentMethodId,
boolean includedInactive,
boolean withPluginInfo,
Iterable<PluginProperty> properties,
TenantContext context) |
Pagination<PaymentMethod> |
PaymentApi.getPaymentMethods(Long offset,
Long limit,
boolean withPluginInfo,
Iterable<PluginProperty> properties,
TenantContext context)
Find all payment methods across all plugins
|
Pagination<PaymentMethod> |
PaymentApi.getPaymentMethods(Long offset,
Long limit,
String pluginName,
boolean withPluginInfo,
Iterable<PluginProperty> properties,
TenantContext context)
Find all payment methods in a given plugin
|
Pagination<Payment> |
PaymentApi.getPayments(Long offset,
Long limit,
boolean withPluginInfo,
Iterable<PluginProperty> properties,
TenantContext context)
Find all payments across all plugins
|
Pagination<Payment> |
PaymentApi.getPayments(Long offset,
Long limit,
String pluginName,
boolean withPluginInfo,
Iterable<PluginProperty> properties,
TenantContext context)
Find all payments in a given plugin
|
Pagination<PaymentMethod> |
PaymentApi.searchPaymentMethods(String searchKey,
Long offset,
Long limit,
boolean withPluginInfo,
Iterable<PluginProperty> properties,
TenantContext context)
Find all payment methods matching the search key across all plugins
The match will be plugin specific: for instance some plugins will try to match the key
against the last 4 credit cards digits, agreement ids, etc.
|
Pagination<PaymentMethod> |
PaymentApi.searchPaymentMethods(String searchKey,
Long offset,
Long limit,
String pluginName,
boolean withPluginInfo,
Iterable<PluginProperty> properties,
TenantContext context)
Find all payment methods matching the search key in a given plugin
The match will be plugin specific: for instance some plugins will try to match the key
against the last 4 credit cards digits, agreement ids, etc.
|
Pagination<Payment> |
PaymentApi.searchPayments(String searchKey,
Long offset,
Long limit,
boolean withPluginInfo,
Iterable<PluginProperty> properties,
TenantContext context)
Find all payments matching the search key across all plugins
The match will be plugin specific: for instance some plugins will try to match the key
against the transaction ids, etc.
|
Pagination<Payment> |
PaymentApi.searchPayments(String searchKey,
Long offset,
Long limit,
String pluginName,
boolean withPluginInfo,
Iterable<PluginProperty> properties,
TenantContext context)
Find all payments matching the search key in a given plugin
The match will be plugin specific: for instance some plugins will try to match the key
against the transaction ids, etc.
|
| Modifier and Type | Method and Description |
|---|---|
void |
SecurityApi.checkCurrentUserPermissions(List<Permission> permissions,
Logical logical,
TenantContext context)
Check the current user has the set of permissions.
|
Set<Permission> |
SecurityApi.getCurrentUserPermissions(TenantContext context)
Return the set of permissions for the currently logged-in user.
|
List<String> |
SecurityApi.getRoleDefinition(String role,
TenantContext tenantContext)
Retrieves the list of permissions associated to that role in the Shiro store (JDBCRealm)
|
List<String> |
SecurityApi.getUserRoles(String username,
TenantContext tenantContext)
Retrieves the roles associated to a user in the Shiro store (JDBCRealm)
|
| Modifier and Type | Method and Description |
|---|---|
List<String> |
TenantUserApi.getTenantValuesForKey(String key,
TenantContext context) |
| Modifier and Type | Method and Description |
|---|---|
List<RolledUpUsage> |
UsageUserApi.getAllUsageForSubscription(UUID subscriptionId,
List<org.joda.time.LocalDate> transitionDates,
TenantContext context)
Get usage information for a given subscription.
|
RolledUpUsage |
UsageUserApi.getUsageForSubscription(UUID subscriptionId,
String unitType,
org.joda.time.LocalDate startDate,
org.joda.time.LocalDate endDate,
TenantContext context)
Get usage information for a given subscription.
|
| Modifier and Type | Method and Description |
|---|---|
AccountAuditLogs |
AuditUserApi.getAccountAuditLogs(UUID accountId,
AuditLevel auditLevel,
TenantContext context)
Retrieve all audit logs (for all objects) for a given account
|
AccountAuditLogsForObjectType |
AuditUserApi.getAccountAuditLogs(UUID accountId,
ObjectType objectType,
AuditLevel auditLevel,
TenantContext context)
Retrieve all audit logs (for all objects of a given type) for a given account
|
List<AuditLog> |
AuditUserApi.getAuditLogs(UUID objectId,
ObjectType objectType,
AuditLevel auditLevel,
TenantContext context)
Get all the audit entries for a given object.
|
Pagination<CustomField> |
CustomFieldUserApi.getCustomFields(Long offset,
Long limit,
TenantContext context) |
List<CustomField> |
CustomFieldUserApi.getCustomFieldsForAccount(UUID accountId,
TenantContext context) |
List<CustomField> |
CustomFieldUserApi.getCustomFieldsForAccountType(UUID accountId,
ObjectType objectType,
TenantContext context) |
List<CustomField> |
CustomFieldUserApi.getCustomFieldsForObject(UUID objectId,
ObjectType objectType,
TenantContext context) |
Long |
RecordIdApi.getRecordId(UUID objectId,
ObjectType objectType,
TenantContext tenantContext)
This can be used by external plugins to keep the mapping between UUID and recordId
|
TagDefinition |
TagUserApi.getTagDefinition(UUID tagDefinitionId,
TenantContext context) |
TagDefinition |
TagUserApi.getTagDefinitionForName(String tageDefinitionName,
TenantContext context) |
List<TagDefinition> |
TagUserApi.getTagDefinitions(Collection<UUID> tagDefinitionIds,
TenantContext context) |
List<TagDefinition> |
TagUserApi.getTagDefinitions(TenantContext context) |
Pagination<Tag> |
TagUserApi.getTags(Long offset,
Long limit,
TenantContext context) |
List<Tag> |
TagUserApi.getTagsForAccount(UUID accountId,
boolean includedDeleted,
TenantContext context) |
List<Tag> |
TagUserApi.getTagsForAccountType(UUID accountId,
ObjectType objectType,
boolean includedDeleted,
TenantContext context) |
List<Tag> |
TagUserApi.getTagsForObject(UUID objectId,
ObjectType objectType,
boolean includedDeleted,
TenantContext context) |
Pagination<CustomField> |
CustomFieldUserApi.searchCustomFields(String searchKey,
Long offset,
Long limit,
TenantContext context)
Find all custom fields having their object type, field name or value matching the search key
|
Pagination<Tag> |
TagUserApi.searchTags(String searchKey,
Long offset,
Long limit,
TenantContext context)
Find all tags having their object type, associated tag definition name or description matching the search key
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
CallContext
External use
|
Copyright © 2010-2016. All Rights Reserved.