| Modifier and Type | Method and Description |
|---|---|
Account |
AccountUserApi.getAccountById(java.util.UUID accountId,
TenantContext context) |
Account |
AccountUserApi.getAccountByKey(java.lang.String key,
TenantContext context)
Retrieves an account by specifying its external key.
|
Pagination<Account> |
AccountUserApi.getAccounts(java.lang.Long offset,
java.lang.Long limit,
TenantContext context) |
java.util.List<AuditLogWithHistory> |
AccountUserApi.getAuditLogsWithHistoryForId(java.util.UUID accountId,
AuditLevel auditLevel,
TenantContext context)
Get all the audit entries with history for a given account.
|
java.util.List<Account> |
AccountUserApi.getChildrenAccounts(java.util.UUID parentAccountId,
TenantContext context) |
java.util.List<AuditLogWithHistory> |
AccountUserApi.getEmailAuditLogsWithHistoryForId(java.util.UUID accountEmailId,
AuditLevel auditLevel,
TenantContext context)
Get all the audit entries with history for a given account email.
|
java.util.List<AccountEmail> |
AccountUserApi.getEmails(java.util.UUID accountId,
TenantContext context) |
java.util.UUID |
AccountUserApi.getIdFromKey(java.lang.String externalKey,
TenantContext context) |
Pagination<Account> |
AccountUserApi.searchAccounts(java.lang.String searchKey,
java.lang.Long offset,
java.lang.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 |
|---|---|
VersionedCatalog<? extends StaticCatalog> |
CatalogUserApi.getCatalog(java.lang.String catalogName,
org.joda.time.DateTime catalogDateVersion,
TenantContext context)
Retrieves the multi versioned catalog.
|
StaticCatalog |
CatalogUserApi.getCurrentCatalog(java.lang.String catalogName,
TenantContext context)
Retrieves the current catalog
|
| Modifier and Type | Method and Description |
|---|---|
SubscriptionBundle |
SubscriptionApi.getActiveSubscriptionBundleForExternalKey(java.lang.String externalKey,
TenantContext context)
Retrieves all the
SubscriptionBundle for the given external key. |
java.util.List<Entitlement> |
EntitlementApi.getAllEntitlementsForAccountId(java.util.UUID accountId,
TenantContext context)
Retrieves all the
Entitlement for a given account. |
java.util.List<Entitlement> |
EntitlementApi.getAllEntitlementsForAccountIdAndExternalKey(java.util.UUID accountId,
java.lang.String externalKey,
TenantContext context)
Retrieves all the
Entitlement for a given account and matching an external key. |
java.util.List<Entitlement> |
EntitlementApi.getAllEntitlementsForBundle(java.util.UUID bundleId,
TenantContext context)
Retrieves all the
Entitlement attached to the base entitlement. |
java.util.List<AuditLogWithHistory> |
SubscriptionApi.getBlockingStateAuditLogsWithHistoryForId(java.util.UUID blockingId,
AuditLevel auditLevel,
TenantContext context)
Get all the audit entries with history for a given blocking state.
|
java.lang.Iterable<BlockingState> |
SubscriptionApi.getBlockingStates(java.util.UUID accountId,
java.util.List<BlockingStateType> typeFilter,
java.util.List<java.lang.String> svcsFilter,
OrderingType orderingType,
int timeFilter,
TenantContext context) |
java.util.List<EntitlementAOStatusDryRun> |
EntitlementApi.getDryRunStatusForChange(java.util.UUID bundleId,
java.lang.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(java.util.UUID id,
TenantContext context)
Retrieves an
Entitlement using its id. |
java.util.List<AuditLogWithHistory> |
SubscriptionApi.getSubscriptionAuditLogsWithHistoryForId(java.util.UUID entitlementId,
AuditLevel auditLevel,
TenantContext context)
Get all the audit entries with history for a given subscription.
|
SubscriptionBundle |
SubscriptionApi.getSubscriptionBundle(java.util.UUID bundleId,
TenantContext context)
Retrieves all the
Subscription attached to the base entitlement. |
java.util.List<AuditLogWithHistory> |
SubscriptionApi.getSubscriptionBundleAuditLogsWithHistoryForId(java.util.UUID bundleId,
AuditLevel auditLevel,
TenantContext context)
Get all the audit entries with history for a given bundle.
|
Pagination<SubscriptionBundle> |
SubscriptionApi.getSubscriptionBundles(java.lang.Long offset,
java.lang.Long limit,
TenantContext context) |
java.util.List<SubscriptionBundle> |
SubscriptionApi.getSubscriptionBundlesForAccountId(java.util.UUID accountId,
TenantContext context)
Retrieves all the
SubscriptionBundle for a given account. |
java.util.List<SubscriptionBundle> |
SubscriptionApi.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> |
SubscriptionApi.getSubscriptionBundlesForExternalKey(java.lang.String externalKey,
TenantContext context)
Returns an ordered list of all
SubscriptionBundle for a given external key. |
java.util.List<AuditLogWithHistory> |
SubscriptionApi.getSubscriptionEventAuditLogsWithHistoryForId(java.util.UUID EventId,
AuditLevel auditLevel,
TenantContext context)
Get all the audit entries with history for a given subscription event.
|
Subscription |
SubscriptionApi.getSubscriptionForEntitlementId(java.util.UUID entitlementId,
TenantContext context)
Retrieves a
Subscription For the entitlementId |
Pagination<SubscriptionBundle> |
SubscriptionApi.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 |
| Modifier and Type | Method and Description |
|---|---|
java.math.BigDecimal |
InvoiceUserApi.getAccountBalance(java.util.UUID accountId,
TenantContext context)
Retrieve the account balance.
|
java.math.BigDecimal |
InvoiceUserApi.getAccountCBA(java.util.UUID accountId,
TenantContext context)
Retrieve the account CBA.
|
InvoiceItem |
InvoiceUserApi.getCreditById(java.util.UUID creditId,
TenantContext context)
Retrieve a credit by id.
|
InvoiceItem |
InvoiceUserApi.getExternalChargeById(java.util.UUID externalChargeId,
TenantContext context)
Retrieve an external charge by id.
|
Invoice |
InvoiceUserApi.getInvoice(java.util.UUID invoiceId,
TenantContext context)
Retrieve an invoice by id.
|
java.lang.String |
InvoiceUserApi.getInvoiceAsHTML(java.util.UUID invoiceId,
TenantContext context)
Retrieve the invoice formatted in HTML.
|
java.util.List<AuditLogWithHistory> |
InvoiceUserApi.getInvoiceAuditLogsWithHistoryForId(java.util.UUID invoiceId,
AuditLevel auditLevel,
TenantContext context)
Get all the audit entries with history for a given invoice.
|
Invoice |
InvoiceUserApi.getInvoiceByInvoiceItem(java.util.UUID invoiceItemId,
TenantContext context) |
Invoice |
InvoiceUserApi.getInvoiceByNumber(java.lang.Integer number,
TenantContext context)
Retrieve an invoice by invoice number.
|
Invoice |
InvoiceUserApi.getInvoiceByPayment(java.util.UUID paymentId,
TenantContext context)
Get all invoices for a given payment.
|
java.util.List<AuditLogWithHistory> |
InvoiceUserApi.getInvoiceItemAuditLogsWithHistoryForId(java.util.UUID invoiceItemId,
AuditLevel auditLevel,
TenantContext context)
Get all the audit entries with history for a given invoice item.
|
java.util.List<InvoiceItem> |
InvoiceUserApi.getInvoiceItemsByParentInvoice(java.util.UUID parentInvoiceId,
TenantContext context)
Retrieve invoice items details associated to Parent SUMMARY invoice item
|
java.util.List<AuditLogWithHistory> |
InvoiceUserApi.getInvoicePaymentAuditLogsWithHistoryForId(java.util.UUID invoicePaymentId,
AuditLevel auditLevel,
TenantContext context)
Get all the audit entries with history for a given invoice payment.
|
Pagination<Invoice> |
InvoiceUserApi.getInvoices(java.lang.Long offset,
java.lang.Long limit,
TenantContext context) |
java.util.List<Invoice> |
InvoiceUserApi.getInvoicesByAccount(java.util.UUID accountId,
boolean includesMigrated,
boolean includeVoidedInvoices,
TenantContext context)
Get all invoices for a given account.
|
java.util.List<Invoice> |
InvoiceUserApi.getInvoicesByAccount(java.util.UUID accountId,
org.joda.time.LocalDate fromDate,
boolean includeVoidedInvoices,
TenantContext context)
Find invoices from a given day, for a given account.
|
java.util.Collection<Invoice> |
InvoiceUserApi.getUnpaidInvoicesByAccountId(java.util.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(java.lang.String searchKey,
java.lang.Long offset,
java.lang.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(java.util.UUID accountId,
TenantContext context) |
| Modifier and Type | Method and Description |
|---|---|
java.util.List<PaymentMethod> |
PaymentApi.getAccountPaymentMethods(java.util.UUID accountId,
boolean includedInactive,
boolean withPluginInfo,
java.lang.Iterable<PluginProperty> properties,
TenantContext context) |
java.util.List<Payment> |
PaymentApi.getAccountPayments(java.util.UUID accountId,
boolean withPluginInfo,
boolean withAttempts,
java.lang.Iterable<PluginProperty> properties,
TenantContext context) |
InvoicePayment |
InvoicePaymentApi.getInvoicePayment(java.util.UUID invoicePaymentId,
TenantContext context) |
java.util.List<InvoicePayment> |
InvoicePaymentApi.getInvoicePayments(java.util.UUID paymentId,
TenantContext context) |
java.util.List<InvoicePayment> |
InvoicePaymentApi.getInvoicePaymentsByAccount(java.util.UUID accountId,
TenantContext context) |
Payment |
PaymentApi.getPayment(java.util.UUID paymentId,
boolean withPluginInfo,
boolean withAttempts,
java.lang.Iterable<PluginProperty> properties,
TenantContext context) |
java.util.List<AuditLogWithHistory> |
PaymentApi.getPaymentAttemptAuditLogsWithHistoryForId(java.util.UUID paymentAttemptId,
AuditLevel auditLevel,
TenantContext context)
Get all the audit entries with history for a given payment attempt.
|
java.util.List<AuditLogWithHistory> |
PaymentApi.getPaymentAuditLogsWithHistoryForId(java.util.UUID paymentId,
AuditLevel auditLevel,
TenantContext context)
Get all the audit entries with history for a given payment.
|
Payment |
PaymentApi.getPaymentByExternalKey(java.lang.String paymentExternalKey,
boolean withPluginInfo,
boolean withAttempts,
java.lang.Iterable<PluginProperty> properties,
TenantContext context) |
Payment |
PaymentApi.getPaymentByTransactionExternalKey(java.lang.String transactionExternalKey,
boolean withPluginInfo,
boolean withAttempts,
java.lang.Iterable<PluginProperty> properties,
TenantContext context) |
Payment |
PaymentApi.getPaymentByTransactionId(java.util.UUID transactionId,
boolean withPluginInfo,
boolean withAttempts,
java.lang.Iterable<PluginProperty> properties,
TenantContext context) |
java.util.List<AuditLogWithHistory> |
PaymentApi.getPaymentMethodAuditLogsWithHistoryForId(java.util.UUID paymentMethodId,
AuditLevel auditLevel,
TenantContext context)
Get all the audit entries with history for a given payment method.
|
PaymentMethod |
PaymentApi.getPaymentMethodByExternalKey(java.lang.String paymentMethodExternalKey,
boolean includedInactive,
boolean withPluginInfo,
java.lang.Iterable<PluginProperty> properties,
TenantContext context) |
PaymentMethod |
PaymentApi.getPaymentMethodById(java.util.UUID paymentMethodId,
boolean includedInactive,
boolean withPluginInfo,
java.lang.Iterable<PluginProperty> properties,
TenantContext context) |
Pagination<PaymentMethod> |
PaymentApi.getPaymentMethods(java.lang.Long offset,
java.lang.Long limit,
boolean withPluginInfo,
java.lang.Iterable<PluginProperty> properties,
TenantContext context)
Find all payment methods across all plugins
|
Pagination<PaymentMethod> |
PaymentApi.getPaymentMethods(java.lang.Long offset,
java.lang.Long limit,
java.lang.String pluginName,
boolean withPluginInfo,
java.lang.Iterable<PluginProperty> properties,
TenantContext context)
Find all payment methods in a given plugin
|
Pagination<Payment> |
PaymentApi.getPayments(java.lang.Long offset,
java.lang.Long limit,
boolean withPluginInfo,
boolean withAttempts,
java.lang.Iterable<PluginProperty> properties,
TenantContext context)
Find all payments across all plugins
|
Pagination<Payment> |
PaymentApi.getPayments(java.lang.Long offset,
java.lang.Long limit,
java.lang.String pluginName,
boolean withPluginInfo,
boolean withAttempts,
java.lang.Iterable<PluginProperty> properties,
TenantContext context)
Find all payments in a given plugin
|
java.util.List<AuditLogWithHistory> |
PaymentApi.getPaymentTransactionAuditLogsWithHistoryForId(java.util.UUID paymentTransactionId,
AuditLevel auditLevel,
TenantContext context)
Get all the audit entries with history for a given payment transaction.
|
Pagination<PaymentMethod> |
PaymentApi.searchPaymentMethods(java.lang.String searchKey,
java.lang.Long offset,
java.lang.Long limit,
boolean withPluginInfo,
java.lang.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(java.lang.String searchKey,
java.lang.Long offset,
java.lang.Long limit,
java.lang.String pluginName,
boolean withPluginInfo,
java.lang.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(java.lang.String searchKey,
java.lang.Long offset,
java.lang.Long limit,
boolean withPluginInfo,
boolean withAttempts,
java.lang.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(java.lang.String searchKey,
java.lang.Long offset,
java.lang.Long limit,
java.lang.String pluginName,
boolean withPluginInfo,
boolean withAttempts,
java.lang.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(java.util.List<Permission> permissions,
Logical logical,
TenantContext context)
Check the current user has the set of permissions.
|
java.util.Set<Permission> |
SecurityApi.getCurrentUserPermissions(TenantContext context)
Return the set of permissions for the currently logged-in user.
|
java.util.List<java.lang.String> |
SecurityApi.getRoleDefinition(java.lang.String role,
TenantContext tenantContext)
Retrieves the list of permissions associated to that role in the Shiro store (JDBCRealm)
|
java.util.List<java.lang.String> |
SecurityApi.getUserRoles(java.lang.String username,
TenantContext tenantContext)
Retrieves the roles associated to a user in the Shiro store (JDBCRealm)
|
| Modifier and Type | Method and Description |
|---|---|
java.util.List<java.lang.String> |
TenantUserApi.getTenantValuesForKey(java.lang.String key,
TenantContext context) |
java.util.Map<java.lang.String,java.util.List<java.lang.String>> |
TenantUserApi.searchTenantKeyValues(java.lang.String searchKey,
TenantContext context) |
| Modifier and Type | Method and Description |
|---|---|
java.util.List<RolledUpUsage> |
UsageUserApi.getAllUsageForSubscription(java.util.UUID subscriptionId,
java.util.List<org.joda.time.LocalDate> transitionDates,
TenantContext context)
Get usage information for a given subscription.
|
RolledUpUsage |
UsageUserApi.getUsageForSubscription(java.util.UUID subscriptionId,
java.lang.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(java.util.UUID accountId,
AuditLevel auditLevel,
TenantContext context)
Retrieve all audit logs (for all objects) for a given account
|
AccountAuditLogsForObjectType |
AuditUserApi.getAccountAuditLogs(java.util.UUID accountId,
ObjectType objectType,
AuditLevel auditLevel,
TenantContext context)
Retrieve all audit logs (for all objects of a given type) for a given account
|
java.util.List<AuditLog> |
AuditUserApi.getAuditLogs(java.util.UUID objectId,
ObjectType objectType,
AuditLevel auditLevel,
TenantContext context)
Get all the audit entries for a given object.
|
java.util.List<AuditLogWithHistory> |
CustomFieldUserApi.getCustomFieldAuditLogsWithHistoryForId(java.util.UUID customFieldId,
AuditLevel auditLevel,
TenantContext context)
Get all the audit entries with history for a given custom field.
|
Pagination<CustomField> |
CustomFieldUserApi.getCustomFields(java.lang.Long offset,
java.lang.Long limit,
TenantContext context) |
java.util.List<CustomField> |
CustomFieldUserApi.getCustomFieldsForAccount(java.util.UUID accountId,
TenantContext context) |
java.util.List<CustomField> |
CustomFieldUserApi.getCustomFieldsForAccountType(java.util.UUID accountId,
ObjectType objectType,
TenantContext context) |
java.util.List<CustomField> |
CustomFieldUserApi.getCustomFieldsForObject(java.util.UUID objectId,
ObjectType objectType,
TenantContext context) |
java.lang.Long |
RecordIdApi.getRecordId(java.util.UUID objectId,
ObjectType objectType,
TenantContext tenantContext)
This can be used by external plugins to keep the mapping between UUID and recordId
|
java.util.List<AuditLogWithHistory> |
TagUserApi.getTagAuditLogsWithHistoryForId(java.util.UUID tagId,
AuditLevel auditLevel,
TenantContext context)
Get all the audit entries with history for a given tag.
|
TagDefinition |
TagUserApi.getTagDefinition(java.util.UUID tagDefinitionId,
TenantContext context) |
java.util.List<AuditLogWithHistory> |
TagUserApi.getTagDefinitionAuditLogsWithHistoryForId(java.util.UUID tagDefinitionId,
AuditLevel auditLevel,
TenantContext context)
Get all the audit entries with history for a given tag definition.
|
TagDefinition |
TagUserApi.getTagDefinitionForName(java.lang.String tageDefinitionName,
TenantContext context) |
java.util.List<TagDefinition> |
TagUserApi.getTagDefinitions(java.util.Collection<java.util.UUID> tagDefinitionIds,
TenantContext context) |
java.util.List<TagDefinition> |
TagUserApi.getTagDefinitions(TenantContext context) |
Pagination<Tag> |
TagUserApi.getTags(java.lang.Long offset,
java.lang.Long limit,
TenantContext context) |
java.util.List<Tag> |
TagUserApi.getTagsForAccount(java.util.UUID accountId,
boolean includedDeleted,
TenantContext context) |
java.util.List<Tag> |
TagUserApi.getTagsForAccountType(java.util.UUID accountId,
ObjectType objectType,
boolean includedDeleted,
TenantContext context) |
java.util.List<Tag> |
TagUserApi.getTagsForObject(java.util.UUID objectId,
ObjectType objectType,
boolean includedDeleted,
TenantContext context) |
Pagination<CustomField> |
CustomFieldUserApi.searchCustomFields(java.lang.String searchKey,
java.lang.Long offset,
java.lang.Long limit,
TenantContext context)
Find all custom fields having their object type, field name or value matching the search key
|
Pagination<CustomField> |
CustomFieldUserApi.searchCustomFields(java.lang.String fieldName,
ObjectType objectType,
java.lang.Long offset,
java.lang.Long limit,
TenantContext context) |
Pagination<CustomField> |
CustomFieldUserApi.searchCustomFields(java.lang.String fieldName,
java.lang.String fieldValue,
ObjectType objectType,
java.lang.Long offset,
java.lang.Long limit,
TenantContext context) |
Pagination<Tag> |
TagUserApi.searchTags(java.lang.String searchKey,
java.lang.Long offset,
java.lang.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-2019. All Rights Reserved.