Package org.killbill.billing.util.api

Interface CustomFieldUserApi

All Superinterfaces:

KillbillApi

public interface CustomFieldUserApi
extends KillbillApi

Method Summary

Modifier and Type	Method	Description
void	addCustomFields(List<CustomField> fields, CallContext context)
List<AuditLogWithHistory>	getCustomFieldAuditLogsWithHistoryForId(UUID customFieldId, AuditLevel auditLevel, TenantContext context)	Get all the audit entries with history for a given custom field.
Pagination<CustomField>	getCustomFields(Long offset, Long limit, TenantContext context)
List<CustomField>	getCustomFieldsForAccount(UUID accountId, TenantContext context)
List<CustomField>	getCustomFieldsForAccountType(UUID accountId, ObjectType objectType, TenantContext context)
List<CustomField>	getCustomFieldsForObject(UUID objectId, ObjectType objectType, TenantContext context)
void	removeCustomFields(List<CustomField> fields, CallContext context)
Pagination<CustomField>	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<CustomField>	searchCustomFields(String fieldName, String fieldValue, ObjectType objectType, Long offset, Long limit, TenantContext context)
Pagination<CustomField>	searchCustomFields(String fieldName, ObjectType objectType, Long offset, Long limit, TenantContext context)
void	updateCustomFields(List<CustomField> fields, CallContext context)

Method Detail

searchCustomFields

Pagination<CustomField> 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

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 custom fields matching this search key for that tenant

searchCustomFields

Pagination<CustomField> searchCustomFields(String fieldName,
                                           String fieldValue,
                                           ObjectType objectType,
                                           Long offset,
                                           Long limit,
                                           TenantContext context)

Parameters:

fieldName - the field name to search for

fieldValue - the field value to search for

objectType - the object type to search for

offset - the offset of the first result

limit - the maximum number of results to retrieve

context - the user context

Returns:

the list of custom fields matching this search for that tenant

searchCustomFields

Pagination<CustomField> searchCustomFields(String fieldName,
                                           ObjectType objectType,
                                           Long offset,
                                           Long limit,
                                           TenantContext context)

Parameters:

fieldName - the field name to search for

objectType - the object type to search for

offset - the offset of the first result

limit - the maximum number of results to retrieve

context - the user context

Returns:

the list of custom fields matching this search for that tenant

getCustomFields

Pagination<CustomField> getCustomFields(Long offset,
                                        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 custom fields for that tenant

addCustomFields

void addCustomFields(List<CustomField> fields,
                     CallContext context)
              throws CustomFieldApiException

Parameters:

fields - the list of fields to add

context - the call context

Throws:

CustomFieldApiException

updateCustomFields

void updateCustomFields(List<CustomField> fields,
                        CallContext context)
                 throws CustomFieldApiException

Parameters:

fields - the list of fields to add

context - the call context

Throws:

CustomFieldApiException

removeCustomFields

void removeCustomFields(List<CustomField> fields,
                        CallContext context)
                 throws CustomFieldApiException

Parameters:

fields -

context -

Throws:

CustomFieldApiException

getCustomFieldsForObject

List<CustomField> getCustomFieldsForObject(UUID objectId,
                                           ObjectType objectType,
                                           TenantContext context)

Parameters:

objectId - the object id

objectType - the object type

context - the call context

Returns:

the list of custom fields associated with that object

getCustomFieldsForAccountType

List<CustomField> getCustomFieldsForAccountType(UUID accountId,
                                                ObjectType objectType,
                                                TenantContext context)

Parameters:

accountId - the account id

objectType - the object type

context - the call context

Returns:

the list of custom fields associated with that account for the specified type

getCustomFieldsForAccount

List<CustomField> getCustomFieldsForAccount(UUID accountId,
                                            TenantContext context)

Parameters:

accountId - the account id

context - the call context

Returns:

the list of custom fields associated with that account

getCustomFieldAuditLogsWithHistoryForId

List<AuditLogWithHistory> getCustomFieldAuditLogsWithHistoryForId(UUID customFieldId,
                                                                  AuditLevel auditLevel,
                                                                  TenantContext context)

Get all the audit entries with history for a given custom field.

Parameters:

customFieldId - the custom field id

auditLevel - audit level (verbosity)

context - the tenant context

Returns:

all audit entries with history for a custom field