org.finra.herd.service

Interface TagService

All Known Implementing Classes:

TagServiceImpl

public interface TagService

The tag service

Method Summary

Modifier and Type	Method and Description
Tag	createTag(TagCreateRequest tagCreateRequest) Creates a new tag.
Tag	deleteTag(TagKey tagKey) Deletes an existing tag.
Tag	getTag(TagKey tagKey) Retrieves an existing tag.
TagListResponse	getTags(String tagTypeCode, String tagCode) Retrieves all associated tags for the specified tag type code.
TagSearchResponse	searchTags(TagSearchRequest request, Set<String> fields) Retrieves all tags existing in the system per specified search filters and keys.
void	updateSearchIndexDocumentTag(SearchIndexUpdateDto searchIndexUpdateDto) Updates the search index document representation of the tag.
Tag	updateTag(TagKey tagKey, TagUpdateRequest tagUpdateRequest) Updates an existing tag.

Method Detail

createTag

Tag createTag(TagCreateRequest tagCreateRequest)

Creates a new tag.

Parameters:

tagCreateRequest - the tag create request.

Returns:

the created tag.

deleteTag

Tag deleteTag(TagKey tagKey)

Deletes an existing tag.

Parameters:

tagKey - the tag's key.

Returns:

the deleted tag.

getTag

Tag getTag(TagKey tagKey)

Retrieves an existing tag.

Parameters:

tagKey - the tag's key.

Returns:

the tag.

getTags

TagListResponse getTags(String tagTypeCode,
                        String tagCode)

Retrieves all associated tags for the specified tag type code.

When tagCode is null, return all tags of the tag type code.

When tagCode is provided, return all tags of the tag type code and whose parent tag code is tagCode.

Parameters:

tagTypeCode - the tag type's code.

tagCode - the tag code.

Returns:

all associated tags, with parent, itself and the children tags with has more children flag.

searchTags

TagSearchResponse searchTags(TagSearchRequest request,
                             Set<String> fields)

Retrieves all tags existing in the system per specified search filters and keys. For each tag entity, this endpoint returns tag key by default along with any other top-level elements as specified by the "fields" query string parameter. The list of tags returned by this endpoint is sorted alphabetically by tag's display name ascending.

Parameters:

request - the tag search request. The request can only accept at most one search filter and a single search key

fields - the field options for the tag type search response

Returns:

the tag search response

updateSearchIndexDocumentTag

void updateSearchIndexDocumentTag(SearchIndexUpdateDto searchIndexUpdateDto)

Updates the search index document representation of the tag.

Parameters:

searchIndexUpdateDto - the SearchIndexUpdateDto object

updateTag

Tag updateTag(TagKey tagKey,
              TagUpdateRequest tagUpdateRequest)

Updates an existing tag.

Parameters:

tagKey - the tag's key.

tagUpdateRequest - the tag update request.

Returns:

the updated tag.