org.killbill.billing.util.api

Interface TagUserApi

All Superinterfaces:

KillbillApi

public interface TagUserApi
extends KillbillApi

Method Summary

Modifier and Type	Method and Description
void	addTag(java.util.UUID objectId, ObjectType objectType, java.util.UUID tagDefinitionId, CallContext context)
void	addTags(java.util.UUID objectId, ObjectType objectType, java.util.Collection<java.util.UUID> tagDefinitionIds, CallContext context)
TagDefinition	createTagDefinition(java.lang.String definitionName, java.lang.String description, java.util.Set<ObjectType> applicableObjectTypes, CallContext context)
void	deleteTagDefinition(java.util.UUID tagDefinitionId, CallContext context)
java.util.List<AuditLogWithHistory>	getTagAuditLogsWithHistoryForId(java.util.UUID tagId, AuditLevel auditLevel, TenantContext context) Get all the audit entries with history for a given tag.
TagDefinition	getTagDefinition(java.util.UUID tagDefinitionId, TenantContext context)
java.util.List<AuditLogWithHistory>	getTagDefinitionAuditLogsWithHistoryForId(java.util.UUID tagDefinitionId, AuditLevel auditLevel, TenantContext context) Get all the audit entries with history for a given tag definition.
TagDefinition	getTagDefinitionForName(java.lang.String tageDefinitionName, TenantContext context)
java.util.List<TagDefinition>	getTagDefinitions(java.util.Collection<java.util.UUID> tagDefinitionIds, TenantContext context)
java.util.List<TagDefinition>	getTagDefinitions(TenantContext context)
Pagination<Tag>	getTags(java.lang.Long offset, java.lang.Long limit, TenantContext context)
java.util.List<Tag>	getTagsForAccount(java.util.UUID accountId, boolean includedDeleted, TenantContext context)
java.util.List<Tag>	getTagsForAccountType(java.util.UUID accountId, ObjectType objectType, boolean includedDeleted, TenantContext context)
java.util.List<Tag>	getTagsForObject(java.util.UUID objectId, ObjectType objectType, boolean includedDeleted, TenantContext context)
void	removeTag(java.util.UUID objectId, ObjectType objectType, java.util.UUID tagDefinitionId, CallContext context)
void	removeTags(java.util.UUID objectId, ObjectType objectType, java.util.Collection<java.util.UUID> tagDefinitions, CallContext context)
Pagination<Tag>	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

Method Detail

getTagDefinitions

java.util.List<TagDefinition> getTagDefinitions(TenantContext context)

Parameters:

context - The tenant context

Returns:

the list of all available tag definitions

createTagDefinition

TagDefinition createTagDefinition(java.lang.String definitionName,
                                  java.lang.String description,
                                  java.util.Set<ObjectType> applicableObjectTypes,
                                  CallContext context)
                           throws TagDefinitionApiException

Parameters:

definitionName - Identifies the definition.

description - Describes the use of the definition.

context - The call context, for auditing purposes

Returns:

the newly created tag definition

Throws:

TagDefinitionApiException

deleteTagDefinition

void deleteTagDefinition(java.util.UUID tagDefinitionId,
                         CallContext context)
                  throws TagDefinitionApiException

Parameters:

tagDefinitionId - The UUID for that tagDefinition

context - The call context, for auditing purposes

Throws:

TagDefinitionApiException

getTagDefinition

TagDefinition getTagDefinition(java.util.UUID tagDefinitionId,
                               TenantContext context)
                        throws TagDefinitionApiException

Parameters:

tagDefinitionId - The tag definition id

context - The call context, for auditing purposes

Returns:

The Tag definition

Throws:

TagDefinitionApiException

getTagDefinitionForName

TagDefinition getTagDefinitionForName(java.lang.String tageDefinitionName,
                                      TenantContext context)
                               throws TagDefinitionApiException

Parameters:

tageDefinitionName - The tag definition name

context - The call context, for auditing purposes

Returns:

the tag definition

Throws:

TagDefinitionApiException

getTagDefinitions

java.util.List<TagDefinition> getTagDefinitions(java.util.Collection<java.util.UUID> tagDefinitionIds,
                                                TenantContext context)
                                         throws TagDefinitionApiException

Parameters:

tagDefinitionIds - The collection of the defintion ids

context - The call context, for auditing purposes

Returns:

the tag definition

Throws:

TagDefinitionApiException

addTags

void addTags(java.util.UUID objectId,
             ObjectType objectType,
             java.util.Collection<java.util.UUID> tagDefinitionIds,
             CallContext context)
      throws TagApiException

Parameters:

objectId - The id for the object on which to add tags

objectType - The object type

tagDefinitionIds - The collection of tag definition ids

context - The call context, for auditing purposes

Throws:

TagApiException

addTag

void addTag(java.util.UUID objectId,
            ObjectType objectType,
            java.util.UUID tagDefinitionId,
            CallContext context)
     throws TagApiException

Parameters:

objectId - The id for the object on which to add tags

objectType - The object type

tagDefinitionId - The tag definition id

context - The call context, for auditing purposes

Throws:

TagApiException

removeTags

void removeTags(java.util.UUID objectId,
                ObjectType objectType,
                java.util.Collection<java.util.UUID> tagDefinitions,
                CallContext context)
         throws TagApiException

Parameters:

objectId - The id for the object on which to add tags

objectType - The object type

tagDefinitions - The collection of tag definition ids

context - The call context, for auditing purposes

Throws:

TagApiException

removeTag

void removeTag(java.util.UUID objectId,
               ObjectType objectType,
               java.util.UUID tagDefinitionId,
               CallContext context)
        throws TagApiException

Parameters:

objectId - The id for the object on which to add tags

objectType - The object type

tagDefinitionId - The tage definition id

context - The call context, for auditing purposes

Throws:

TagApiException

searchTags

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

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

getTags

Pagination<Tag> getTags(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 tags for that tenant

getTagsForObject

java.util.List<Tag> getTagsForObject(java.util.UUID objectId,
                                     ObjectType objectType,
                                     boolean includedDeleted,
                                     TenantContext context)

Parameters:

objectId - UUID of the object on which to retrieve the tags

objectType - The type of object

includedDeleted - Whether to include deleted tags

context - The tenant context

Returns:

A map of tag, key being the tagId, and value the tag

getTagsForAccountType

java.util.List<Tag> getTagsForAccountType(java.util.UUID accountId,
                                          ObjectType objectType,
                                          boolean includedDeleted,
                                          TenantContext context)

Parameters:

accountId - The account id

objectType - The type of object on which to retrieve the tags

includedDeleted - Whether to include deleted tags

context - The tenant context

Returns:

A list of tags for that object type and that given account

getTagsForAccount

java.util.List<Tag> getTagsForAccount(java.util.UUID accountId,
                                      boolean includedDeleted,
                                      TenantContext context)

Parameters:

accountId - The account id

includedDeleted - Whether to include deleted tags

context - The tenant context

Returns:

A list of tags for that given account

getTagAuditLogsWithHistoryForId

java.util.List<AuditLogWithHistory> getTagAuditLogsWithHistoryForId(java.util.UUID tagId,
                                                                    AuditLevel auditLevel,
                                                                    TenantContext context)

Get all the audit entries with history for a given tag.

Parameters:

tagId - the custom field id

auditLevel - audit level (verbosity)

context - the tenant context

Returns:

all audit entries with history for a tag

getTagDefinitionAuditLogsWithHistoryForId

java.util.List<AuditLogWithHistory> getTagDefinitionAuditLogsWithHistoryForId(java.util.UUID tagDefinitionId,
                                                                              AuditLevel auditLevel,
                                                                              TenantContext context)

Get all the audit entries with history for a given tag definition.

Parameters:

tagDefinitionId - the custom field id

auditLevel - audit level (verbosity)

context - the tenant context

Returns:

all audit entries with history for a tag definition