org.finra.herd.rest

Class BusinessObjectDefinitionTagRestController

java.lang.Object

org.finra.herd.rest.HerdBaseController

org.finra.herd.rest.BusinessObjectDefinitionTagRestController

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

The REST controller that handles business object definition tag requests.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUSINESS_OBJECT_DEFINITION_TAGS_URI_PREFIX

Constructor Summary

Constructors

Constructor and Description
BusinessObjectDefinitionTagRestController()

Method Summary

Modifier and Type	Method and Description
BusinessObjectDefinitionTag	createBusinessObjectDefinitionTag(BusinessObjectDefinitionTagCreateRequest request) Creates a new business object definition tag.
BusinessObjectDefinitionTag	deleteBusinessObjectDefinitionTag(String namespace, String businessObjectDefinitionName, String tagTypeCode, String tagCode) Deletes an existing business object definition tag.
BusinessObjectDefinitionTagKeys	getBusinessObjectDefinitionTagsByBusinessObjectDefinition(String namespace, String businessObjectDefinitionName) Gets a list of keys for all existing business object definition tags that are associated with the specified business object definition.
BusinessObjectDefinitionTagKeys	getBusinessObjectDefinitionTagsByTag(String tagTypeCode, String tagCode) Gets a list of keys for all existing business object definition tags that are associated with the specified tag.

Methods inherited from class org.finra.herd.rest.HerdBaseController

addPagingHttpHeaders, validateNoDuplicateQueryStringParams

Methods inherited from class java.lang.Object

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

Field Detail

BUSINESS_OBJECT_DEFINITION_TAGS_URI_PREFIX

public static final String BUSINESS_OBJECT_DEFINITION_TAGS_URI_PREFIX

See Also:

Constant Field Values

Constructor Detail

BusinessObjectDefinitionTagRestController

public BusinessObjectDefinitionTagRestController()

Method Detail

createBusinessObjectDefinitionTag

@RequestMapping(value="/businessObjectDefinitionTags",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_BUSINESS_OBJECT_DEFINITION_TAGS_POST")
public BusinessObjectDefinitionTag createBusinessObjectDefinitionTag(@RequestBody
                                                                                                                                                                                                                                                                                     BusinessObjectDefinitionTagCreateRequest request)

Creates a new business object definition tag.

Requires WRITE or WRITE_DESCRIPTIVE_CONTENT permission on namespace

Parameters:

request - the information needed to create a business object definition tag

Returns:

the newly created business object definition tag

deleteBusinessObjectDefinitionTag

@RequestMapping(value="/businessObjectDefinitionTags/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/tagTypes/{tagTypeCode}/tagCodes/{tagCode}",
                method=DELETE)
 @Secured(value="FN_BUSINESS_OBJECT_DEFINITION_TAGS_DELETE")
public BusinessObjectDefinitionTag deleteBusinessObjectDefinitionTag(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                                                      String namespace,
                                                                                                                                                                                                                                                                                                                                                      @PathVariable(value="businessObjectDefinitionName")
                                                                                                                                                                                                                                                                                                                                                      String businessObjectDefinitionName,
                                                                                                                                                                                                                                                                                                                                                      @PathVariable(value="tagTypeCode")
                                                                                                                                                                                                                                                                                                                                                      String tagTypeCode,
                                                                                                                                                                                                                                                                                                                                                      @PathVariable(value="tagCode")
                                                                                                                                                                                                                                                                                                                                                      String tagCode)

Deletes an existing business object definition tag.

Requires WRITE or WRITE_DESCRIPTIVE_CONTENT permission on namespace

Parameters:

namespace - the namespace of the business object definition

businessObjectDefinitionName - the name of the business object definition

tagTypeCode - the tag type reference code of the tag

tagCode - the tag reference code of the tag

Returns:

the business object definition tag that got deleted

getBusinessObjectDefinitionTagsByBusinessObjectDefinition

@RequestMapping(value="/businessObjectDefinitionTags/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}",
                method=GET)
 @Secured(value="FN_BUSINESS_OBJECT_DEFINITION_TAGS_BY_BUSINESS_OBJECT_DEFINITION_GET")
public BusinessObjectDefinitionTagKeys getBusinessObjectDefinitionTagsByBusinessObjectDefinition(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                                                                String namespace,
                                                                                                                                                                                                                                                                                                                                                                @PathVariable(value="businessObjectDefinitionName")
                                                                                                                                                                                                                                                                                                                                                                String businessObjectDefinitionName)

Gets a list of keys for all existing business object definition tags that are associated with the specified business object definition.

Parameters:

namespace - the namespace of the business object definition

businessObjectDefinitionName - the name of the business object definition

Returns:

the list of business object definition tag keys

getBusinessObjectDefinitionTagsByTag

@RequestMapping(value="/businessObjectDefinitionTags/tagTypes/{tagTypeCode}/tagCodes/{tagCode}",
                method=GET)
 @Secured(value="FN_BUSINESS_OBJECT_DEFINITION_TAGS_BY_TAG_GET")
public BusinessObjectDefinitionTagKeys getBusinessObjectDefinitionTagsByTag(@PathVariable(value="tagTypeCode")
                                                                                                                                                                                                                                                                          String tagTypeCode,
                                                                                                                                                                                                                                                                          @PathVariable(value="tagCode")
                                                                                                                                                                                                                                                                          String tagCode)

Gets a list of keys for all existing business object definition tags that are associated with the specified tag.

Parameters:

tagTypeCode - the tag type reference code

tagCode - the tag reference code

Returns:

the list of business object definition tag keys