org.finra.herd.rest

Class BusinessObjectDefinitionDescriptionSuggestionRestController

java.lang.Object

org.finra.herd.rest.HerdBaseController

org.finra.herd.rest.BusinessObjectDefinitionDescriptionSuggestionRestController

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

The REST controller that handles business object definition description suggestion REST requests.

Constructor Summary

Constructors

Constructor and Description
BusinessObjectDefinitionDescriptionSuggestionRestController()

Method Summary

Modifier and Type	Method and Description
BusinessObjectDefinitionDescriptionSuggestion	acceptBusinessObjectDefinitionDescriptionSuggestion(BusinessObjectDefinitionDescriptionSuggestionAcceptanceRequest request) Accepts suggested business object definition description suggestion by key and updates the corresponding business object definition description.
BusinessObjectDefinitionDescriptionSuggestion	createBusinessObjectDefinitionDescriptionSuggestion(BusinessObjectDefinitionDescriptionSuggestionCreateRequest request) Creates a new business object definition description suggestion.
BusinessObjectDefinitionDescriptionSuggestion	deleteBusinessObjectDefinitionDescriptionSuggestion(String namespace, String businessObjectDefinitionName, String userId) Deletes an existing business object definition description suggestion by key.
BusinessObjectDefinitionDescriptionSuggestion	getBusinessObjectDefinitionDescriptionSuggestionByKey(String namespace, String businessObjectDefinitionName, String userId) Retrieves an existing business object definition description suggestion by key.
BusinessObjectDefinitionDescriptionSuggestionKeys	getBusinessObjectDefinitionDescriptionSuggestions(String namespace, String businessObjectDefinitionName) Retrieves a list of business object definition description suggestion keys for all suggestions registered for a specific business object definition.
BusinessObjectDefinitionDescriptionSuggestionSearchResponse	searchBusinessObjectDefinitionDescriptionSuggestions(Set<String> fields, BusinessObjectDefinitionDescriptionSuggestionSearchRequest request) Retrieve a list of business object definition description suggestions meeting the search criteria filters and fields request.
BusinessObjectDefinitionDescriptionSuggestion	updateBusinessObjectDefinitionDescriptionSuggestion(String namespace, String businessObjectDefinitionName, String userId, BusinessObjectDefinitionDescriptionSuggestionUpdateRequest request) Updates an existing business object definition description suggestion by key.

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

Constructor Detail

BusinessObjectDefinitionDescriptionSuggestionRestController

public BusinessObjectDefinitionDescriptionSuggestionRestController()

Method Detail

createBusinessObjectDefinitionDescriptionSuggestion

@RequestMapping(value="/businessObjectDefinitionDescriptionSuggestions",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_BUSINESS_OBJECT_DEFINITION_DESCRIPTION_SUGGESTIONS_POST")
public BusinessObjectDefinitionDescriptionSuggestion createBusinessObjectDefinitionDescriptionSuggestion(@RequestBody
                                                                                                                                                                                                                                                                                                                                                              BusinessObjectDefinitionDescriptionSuggestionCreateRequest request)

Creates a new business object definition description suggestion.

Parameters:

request - the information needed to create the business object definition description suggestion

Returns:

the created business object definition description suggestion

deleteBusinessObjectDefinitionDescriptionSuggestion

@RequestMapping(value="/businessObjectDefinitionDescriptionSuggestions/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/userIds/{userId}",
                method=DELETE)
 @Secured(value="FN_BUSINESS_OBJECT_DEFINITION_DESCRIPTION_SUGGESTIONS_DELETE")
public BusinessObjectDefinitionDescriptionSuggestion deleteBusinessObjectDefinitionDescriptionSuggestion(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                                                                                                      String namespace,
                                                                                                                                                                                                                                                                                                                                                                                                      @PathVariable(value="businessObjectDefinitionName")
                                                                                                                                                                                                                                                                                                                                                                                                      String businessObjectDefinitionName,
                                                                                                                                                                                                                                                                                                                                                                                                      @PathVariable(value="userId")
                                                                                                                                                                                                                                                                                                                                                                                                      String userId)

Deletes an existing business object definition description suggestion by key.

Parameters:

namespace - the namespace

businessObjectDefinitionName - the business object definition name

userId - the user id

Returns:

the deleted business object definition description suggestion

getBusinessObjectDefinitionDescriptionSuggestionByKey

@RequestMapping(value="/businessObjectDefinitionDescriptionSuggestions/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/userIds/{userId}",
                method=GET)
 @Secured(value="FN_BUSINESS_OBJECT_DEFINITION_DESCRIPTION_SUGGESTIONS_GET")
public BusinessObjectDefinitionDescriptionSuggestion getBusinessObjectDefinitionDescriptionSuggestionByKey(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                                                                                                  String namespace,
                                                                                                                                                                                                                                                                                                                                                                                                  @PathVariable(value="businessObjectDefinitionName")
                                                                                                                                                                                                                                                                                                                                                                                                  String businessObjectDefinitionName,
                                                                                                                                                                                                                                                                                                                                                                                                  @PathVariable(value="userId")
                                                                                                                                                                                                                                                                                                                                                                                                  String userId)

Retrieves an existing business object definition description suggestion by key.

Parameters:

namespace - the namespace

businessObjectDefinitionName - the business object definition name

userId - the user id

Returns:

the retrieved business object definition description suggestion

getBusinessObjectDefinitionDescriptionSuggestions

@RequestMapping(value="/businessObjectDefinitionDescriptionSuggestions/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}",
                method=GET)
 @Secured(value="FN_BUSINESS_OBJECT_DEFINITION_DESCRIPTION_SUGGESTIONS_ALL_GET")
public BusinessObjectDefinitionDescriptionSuggestionKeys getBusinessObjectDefinitionDescriptionSuggestions(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                                                                                     String namespace,
                                                                                                                                                                                                                                                                                                                                                                                     @PathVariable(value="businessObjectDefinitionName")
                                                                                                                                                                                                                                                                                                                                                                                     String businessObjectDefinitionName)

Retrieves a list of business object definition description suggestion keys for all suggestions registered for a specific business object definition. The result list is sorted by userId in ascending order.

Parameters:

namespace - the namespace

businessObjectDefinitionName - the business object definition name

Returns:

the list of retrieved business object definition description suggestion keys

searchBusinessObjectDefinitionDescriptionSuggestions

@RequestMapping(value="/businessObjectDefinitionDescriptionSuggestions/search",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_BUSINESS_OBJECT_DEFINITION_DESCRIPTION_SUGGESTIONS_SEARCH_POST")
public BusinessObjectDefinitionDescriptionSuggestionSearchResponse searchBusinessObjectDefinitionDescriptionSuggestions(@RequestParam(value="fields",required=false,defaultValue="")
                                                                                                                                                                                                                                                                                                                                                                                           Set<String> fields,
                                                                                                                                                                                                                                                                                                                                                                                           @RequestBody
                                                                                                                                                                                                                                                                                                                                                                                           BusinessObjectDefinitionDescriptionSuggestionSearchRequest request)

Retrieve a list of business object definition description suggestions meeting the search criteria filters and fields request.

Parameters:

request - the search criteria needed to find a list of business object definition description suggestions

fields - the field options for the business object definition description suggestions search response. The valid field options are: status, descriptionSuggestion, createdByUserId, createdOn

Returns:

the list of business object definition description suggestions

updateBusinessObjectDefinitionDescriptionSuggestion

@RequestMapping(value="/businessObjectDefinitionDescriptionSuggestions/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/userIds/{userId}",
                method=PUT,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_BUSINESS_OBJECT_DEFINITION_DESCRIPTION_SUGGESTIONS_POST")
public BusinessObjectDefinitionDescriptionSuggestion updateBusinessObjectDefinitionDescriptionSuggestion(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  String namespace,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @PathVariable(value="businessObjectDefinitionName")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  String businessObjectDefinitionName,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @PathVariable(value="userId")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  String userId,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @RequestBody
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  BusinessObjectDefinitionDescriptionSuggestionUpdateRequest request)

Updates an existing business object definition description suggestion by key.

Parameters:

namespace - the namespace

businessObjectDefinitionName - the business object definition name

userId - the user id

request - the information needed to update the business object definition description suggestion

Returns:

the updated business object definition description suggestion

acceptBusinessObjectDefinitionDescriptionSuggestion

@RequestMapping(value="/businessObjectDefinitionDescriptionSuggestions/acceptance",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_BUSINESS_OBJECT_DEFINITION_DESCRIPTION_SUGGESTIONS_ACCEPTANCE_POST")
public BusinessObjectDefinitionDescriptionSuggestion acceptBusinessObjectDefinitionDescriptionSuggestion(@RequestBody
                                                                                                                                                                                                                                                                                                                                                                                    BusinessObjectDefinitionDescriptionSuggestionAcceptanceRequest request)

Accepts suggested business object definition description suggestion by key and updates the corresponding business object definition description.

Parameters:

request - the information needed to accept the business object definition description suggestion.

Returns:

the accepted business object definition description suggestion.