org.finra.herd.service.impl

Class TagServiceImpl

java.lang.Object

org.finra.herd.service.impl.TagServiceImpl

All Implemented Interfaces:

SearchableService, TagService

@Service
 @Transactional(value="herdTransactionManager")
public class TagServiceImpl
extends Object
implements TagService, SearchableService

The tag service implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DESCRIPTION_FIELD
static String	DISPLAY_NAME_FIELD
static String	HAS_CHILDREN_FIELD
static String	PARENT_TAG_KEY_FIELD
static String	SEARCH_SCORE_MULTIPLIER_FIELD

Constructor Summary

Constructors

Constructor and Description
TagServiceImpl()

Method Summary

Modifier and Type	Method and Description
Tag	createTag(TagCreateRequest request) 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.
Set<String>	getValidSearchResponseFields() Returns valid search response fields.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.finra.herd.service.SearchableService

validateSearchResponseFields

Field Detail

DESCRIPTION_FIELD

public static final String DESCRIPTION_FIELD

DISPLAY_NAME_FIELD

public static final String DISPLAY_NAME_FIELD

HAS_CHILDREN_FIELD

public static final String HAS_CHILDREN_FIELD

PARENT_TAG_KEY_FIELD

public static final String PARENT_TAG_KEY_FIELD

SEARCH_SCORE_MULTIPLIER_FIELD

public static final String SEARCH_SCORE_MULTIPLIER_FIELD

Constructor Detail

TagServiceImpl

public TagServiceImpl()

Method Detail

createTag

public Tag createTag(TagCreateRequest request)

Description copied from interface: TagService

Creates a new tag.

Specified by:

createTag in interface TagService

Parameters:

request - the tag create request.

Returns:

the created tag.

deleteTag

public Tag deleteTag(TagKey tagKey)

Description copied from interface: TagService

Deletes an existing tag.

Specified by:

deleteTag in interface TagService

Parameters:

tagKey - the tag's key.

Returns:

the deleted tag.

getTag

public Tag getTag(TagKey tagKey)

Description copied from interface: TagService

Retrieves an existing tag.

Specified by:

getTag in interface TagService

Parameters:

tagKey - the tag's key.

Returns:

the tag.

getTags

public TagListResponse getTags(String tagTypeCode,
                               String tagCode)

Description copied from interface: TagService

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.

Specified by:

getTags in interface TagService

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.

getValidSearchResponseFields

public Set<String> getValidSearchResponseFields()

Description copied from interface: SearchableService

Returns valid search response fields.

Specified by:

getValidSearchResponseFields in interface SearchableService

Returns:

the set of valid search response fields

searchTags

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

Description copied from interface: TagService

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.

Specified by:

searchTags in interface TagService

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

public void updateSearchIndexDocumentTag(SearchIndexUpdateDto searchIndexUpdateDto)

Description copied from interface: TagService

Updates the search index document representation of the tag.

Specified by:

updateSearchIndexDocumentTag in interface TagService

Parameters:

searchIndexUpdateDto - the SearchIndexUpdateDto object

updateTag

public Tag updateTag(TagKey tagKey,
                     TagUpdateRequest tagUpdateRequest)

Description copied from interface: TagService

Updates an existing tag.

Specified by:

updateTag in interface TagService

Parameters:

tagKey - the tag's key.

tagUpdateRequest - the tag update request.

Returns:

the updated tag.