org.finra.herd.service.impl

Class TagTypeServiceImpl

java.lang.Object

org.finra.herd.service.impl.TagTypeServiceImpl

All Implemented Interfaces:

SearchableService, TagTypeService

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

The tag type service implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DESCRIPTION_FIELD
static String	DISPLAY_NAME_FIELD
static String	TAG_TYPE_ORDER_FIELD

Constructor Summary

Constructors

Constructor and Description
TagTypeServiceImpl()

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.
Set<String>	getValidSearchResponseFields() Returns valid search response fields.
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.

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

TAG_TYPE_ORDER_FIELD

public static final String TAG_TYPE_ORDER_FIELD

Constructor Detail

TagTypeServiceImpl

public TagTypeServiceImpl()

Method Detail

createTagType

public TagType createTagType(TagTypeCreateRequest request)

Description copied from interface: TagTypeService

Creates a new tag type.

Specified by:

createTagType in interface TagTypeService

Parameters:

request - the tag type create request

Returns:

the created tag type

deleteTagType

public TagType deleteTagType(TagTypeKey tagTypeKey)

Description copied from interface: TagTypeService

Deletes a tag type.

Specified by:

deleteTagType in interface TagTypeService

Parameters:

tagTypeKey - the tag type key

Returns:

the deleted tag type

getTagType

public TagType getTagType(TagTypeKey tagTypeKey)

Description copied from interface: TagTypeService

Retrieve a tag type.

Specified by:

getTagType in interface TagTypeService

Parameters:

tagTypeKey - the tag type key

Returns:

the retrieved tag type

getTagTypes

public TagTypeKeys getTagTypes()

Description copied from interface: TagTypeService

Retrieves a list of tag type keys.

Specified by:

getTagTypes in interface TagTypeService

Returns:

the list of retrieved tag type keys

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

searchTagTypes

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

Description copied from interface: TagTypeService

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.

Specified by:

searchTagTypes in interface TagTypeService

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

public TagType updateTagType(TagTypeKey tagTypeKey,
                             TagTypeUpdateRequest request)

Description copied from interface: TagTypeService

Updates a tag type.

Specified by:

updateTagType in interface TagTypeService

request - the tag type update request

Returns:

the updated tag type