org.finra.herd.rest

Class TagTypeRestController

java.lang.Object

org.finra.herd.rest.TagTypeRestController

@RestController
 @RequestMapping(value="/rest",
                produces={"application/xml","application/json"})
public class TagTypeRestController
extends Object

The REST controller that handles tag type REST requests.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TAG_TYPES_URI_PREFIX

Constructor Summary

Constructors

Constructor and Description
TagTypeRestController()

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

TAG_TYPES_URI_PREFIX

public static final String TAG_TYPES_URI_PREFIX

See Also:

Constant Field Values

Constructor Detail

TagTypeRestController

public TagTypeRestController()

Method Detail

createTagType

@RequestMapping(value="/tagTypes",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_TAG_TYPES_POST")
public TagType createTagType(@RequestBody
                                                                                                                                                                                                   TagTypeCreateRequest request)

Creates a new tag type.

Parameters:

request - the information needed to create the tag type

Returns:

the created tag type

deleteTagType

@RequestMapping(value="/tagTypes/{tagTypeCode}",
                method=DELETE)
 @Secured(value="FN_TAG_TYPES_DELETE")
public TagType deleteTagType(@PathVariable(value="tagTypeCode")
                                                                                                                                                    String tagTypeCode)

Deletes an existing tag type by tag type code.

Parameters:

tagTypeCode - the tag type code

Returns:

the tag type that got deleted

getTagType

@RequestMapping(value="/tagTypes/{tagTypeCode}",
                method=GET)
 @Secured(value="FN_TAG_TYPES_GET")
public TagType getTagType(@PathVariable(value="tagTypeCode")
                                                                                                                                           String tagTypeCode)

Gets an existing tag type by tag type code.

Parameters:

tagTypeCode - the tag type code

Returns:

the retrieved tag type

getTagTypes

@RequestMapping(value="/tagTypes",
                method=GET)
 @Secured(value="FN_TAG_TYPES_ALL_GET")
public TagTypeKeys getTagTypes()

Gets a list of tag type keys for all tag types defined in the system.

Returns:

the list of tag type keys

searchTagTypes

@RequestMapping(value="/tagTypes/search",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_TAG_TYPES_SEARCH_POST")
public TagTypeSearchResponse searchTagTypes(@RequestBody
                                                                                                                                                                                                                                TagTypeSearchRequest request,
                                                                                                                                                                                                                                @RequestParam(value="fields",required=false,defaultValue="")
                                                                                                                                                                                                                                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. The valid field options are: displayName, tagTypeOrder and description

Returns:

the tag type search response

updateTagType

@RequestMapping(value="/tagTypes/{tagTypeCode}",
                method=PUT,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_TAG_TYPES_PUT")
public TagType updateTagType(@PathVariable(value="tagTypeCode")
                                                                                                                                                                                                               String tagTypeCode,
                                                                                                                                                                                                               @RequestBody
                                                                                                                                                                                                               TagTypeUpdateRequest request)

Updates an existing tag type.

Parameters:

tagTypeCode - the tag type code

request - the information needed to update the tag type

Returns:

the updated tag type