org.finra.herd.service

Interface TagTypeService

All Known Implementing Classes:

TagTypeServiceImpl

public interface TagTypeService

The tag type service.

Method Summary

Modifier and Type	Method and Description
TagType	createTagType(TagTypeCreateRequest request) Creates a new tag type.
TagType	deleteTagType(TagTypeKey tagTypeKey) Deletes a tag type.
TagType	getTagType(TagTypeKey tagTypeKey) Retrieve a tag type.
TagTypeKeys	getTagTypes() Retrieves a list of tag type keys.
TagTypeSearchResponse	searchTagTypes(TagTypeSearchRequest request, Set<String> fields) Retrieves all tag types existing in the system.
TagType	updateTagType(TagTypeKey tagTypeKey, TagTypeUpdateRequest request) Updates a tag type.

Method Detail

createTagType

TagType createTagType(TagTypeCreateRequest request)

Creates a new tag type.

Parameters:

request - the tag type create request

Returns:

the created tag type

deleteTagType

TagType deleteTagType(TagTypeKey tagTypeKey)

Deletes a tag type.

Parameters:

tagTypeKey - the tag type key

Returns:

the deleted tag type

getTagType

TagType getTagType(TagTypeKey tagTypeKey)

Retrieve a tag type.

Parameters:

tagTypeKey - the tag type key

Returns:

the retrieved tag type

getTagTypes

TagTypeKeys getTagTypes()

Retrieves a list of tag type keys.

Returns:

the list of retrieved tag type keys

searchTagTypes

TagTypeSearchResponse searchTagTypes(TagTypeSearchRequest request,
                                     Set<String> fields)

Retrieves all tag types existing in the system. For each tag type entity, the endpoint returns tag type key by default along with any other top-level elements as specified by the "fields" query string parameter. The list of tag types returned by the endpoint is sorted alphabetically by tag type's order value ascending.

Parameters:

request - the tag type search request. The request does not take any search keys or filters

fields - the field options for the tag type search response

Returns:

the tag type search response

updateTagType

TagType updateTagType(TagTypeKey tagTypeKey,
                      TagTypeUpdateRequest request)

Updates a tag type.

Parameters:

request - the tag type update request

Returns:

the updated tag type