org.finra.herd.rest

Class BusinessObjectDefinitionRestController

java.lang.Object

org.finra.herd.rest.HerdBaseController

org.finra.herd.rest.BusinessObjectDefinitionRestController

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

The REST controller that handles business object definition REST requests.

Constructor Summary

Constructors

Constructor and Description
BusinessObjectDefinitionRestController()

Method Summary

Modifier and Type	Method and Description
BusinessObjectDefinition	createBusinessObjectDefinition(BusinessObjectDefinitionCreateRequest request) Creates a new business object definition.
BusinessObjectDefinition	deleteBusinessObjectDefinition(String namespace, String businessObjectDefinitionName) Deletes an existing business object definition by key.
BusinessObjectDefinition	getBusinessObjectDefinition(String namespace, String businessObjectDefinitionName, Boolean includeBusinessObjectDefinitionUpdateHistory) Gets an existing business object definition by key.
BusinessObjectDefinitionKeys	getBusinessObjectDefinitions() Gets the list of business object definitions that are defined in the system.
BusinessObjectDefinitionKeys	getBusinessObjectDefinitions(String namespace) Gets the list of business object definitions that are defined in the system.
BusinessObjectDefinitionSearchResponse	searchBusinessObjectDefinitions(Set<String> fields, BusinessObjectDefinitionSearchRequest request) Searches across all business object definitions that are defined in the system per specified search filters and keys
BusinessObjectDefinition	updateBusinessObjectDefinition(String namespace, String businessObjectDefinitionName, BusinessObjectDefinitionUpdateRequest request) Updates an existing business object definition by key.
BusinessObjectDefinition	updateBusinessObjectDefinitionDescriptiveInformation(String namespace, String businessObjectDefinitionName, BusinessObjectDefinitionDescriptiveInformationUpdateRequest request) Updates an existing business object definition descriptive information 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

BusinessObjectDefinitionRestController

public BusinessObjectDefinitionRestController()

Method Detail

createBusinessObjectDefinition

@RequestMapping(value="/businessObjectDefinitions",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_BUSINESS_OBJECT_DEFINITIONS_POST")
public BusinessObjectDefinition createBusinessObjectDefinition(@RequestBody
                                                                                                                                                                                                                                                                        BusinessObjectDefinitionCreateRequest request)

Creates a new business object definition.

Requires WRITE permission on namespace

Parameters:

request - the information needed to create the business object definition.

Returns:

the created business object definition.

updateBusinessObjectDefinition

@RequestMapping(value="/businessObjectDefinitions/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}",
                method=PUT,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_BUSINESS_OBJECT_DEFINITIONS_PUT")
public BusinessObjectDefinition updateBusinessObjectDefinition(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                                                          String namespace,
                                                                                                                                                                                                                                                                                                                                                          @PathVariable(value="businessObjectDefinitionName")
                                                                                                                                                                                                                                                                                                                                                          String businessObjectDefinitionName,
                                                                                                                                                                                                                                                                                                                                                          @RequestBody
                                                                                                                                                                                                                                                                                                                                                          BusinessObjectDefinitionUpdateRequest request)

Updates an existing business object definition by key.

Requires WRITE permission on namespace

If attributes are supplied in the request, this endpoint replaces the entire list of attributes on the business object definition with the contents of the request. Observe this example:

1. Three attributes present on the existing business object definition.
2. This endpoint is called with a single attribute in the request with an updated value.
3. After this operation the business object definition will have only one attribute – which is probably not the desired outcome.
4. Instead, supply all existing attributes and provide updated values and additional attributes as needed. The only case when an existing attribute should be left out is to remove the attribute.

Parameters:

namespace - the namespace code

businessObjectDefinitionName - the name of the business object definition to update

request - the information needed to update the business object definition

Returns:

the updated business object definition

updateBusinessObjectDefinitionDescriptiveInformation

@RequestMapping(value="/businessObjectDefinitionDescriptiveInformation/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}",
                method=PUT,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_BUSINESS_OBJECT_DEFINITIONS_DESCRIPTIVE_INFO_PUT")
public BusinessObjectDefinition updateBusinessObjectDefinitionDescriptiveInformation(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                                                                                                                      String namespace,
                                                                                                                                                                                                                                                                                                                                                                                                                      @PathVariable(value="businessObjectDefinitionName")
                                                                                                                                                                                                                                                                                                                                                                                                                      String businessObjectDefinitionName,
                                                                                                                                                                                                                                                                                                                                                                                                                      @RequestBody
                                                                                                                                                                                                                                                                                                                                                                                                                      BusinessObjectDefinitionDescriptiveInformationUpdateRequest request)

Updates an existing business object definition descriptive information by key.

Requires WRITE or WRITE_DESCRIPTIVE_CONTENT permission on namespace

Parameters:

namespace - the namespace code

businessObjectDefinitionName - the name of the business object definition to update

request - the information needed to update the business object definition

Returns:

the updated business object definition

getBusinessObjectDefinition

@RequestMapping(value="/businessObjectDefinitions/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}",
                method=GET)
 @Secured(value="FN_BUSINESS_OBJECT_DEFINITIONS_GET")
public BusinessObjectDefinition getBusinessObjectDefinition(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                      String namespace,
                                                                                                                                                                                                                                                                                      @PathVariable(value="businessObjectDefinitionName")
                                                                                                                                                                                                                                                                                      String businessObjectDefinitionName,
                                                                                                                                                                                                                                                                                      @RequestParam(value="includeBusinessObjectDefinitionUpdateHistory",required=false)
                                                                                                                                                                                                                                                                                      Boolean includeBusinessObjectDefinitionUpdateHistory)

Gets an existing business object definition by key.

Parameters:

namespace - the namespace code

businessObjectDefinitionName - the business object definition name

Returns:

the retrieved business object definition.

deleteBusinessObjectDefinition

@RequestMapping(value="/businessObjectDefinitions/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}",
                method=DELETE)
 @Secured(value="FN_BUSINESS_OBJECT_DEFINITIONS_DELETE")
public BusinessObjectDefinition deleteBusinessObjectDefinition(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                               String namespace,
                                                                                                                                                                                                                                                                                               @PathVariable(value="businessObjectDefinitionName")
                                                                                                                                                                                                                                                                                               String businessObjectDefinitionName)

Deletes an existing business object definition by key.

Requires WRITE permission on namespace

Parameters:

namespace - the namespace code

businessObjectDefinitionName - the business object definition name

Returns:

the business object definition information of the entity that got deleted

getBusinessObjectDefinitions

@RequestMapping(value="/businessObjectDefinitions",
                method=GET)
 @Secured(value="FN_BUSINESS_OBJECT_DEFINITIONS_ALL_GET")
public BusinessObjectDefinitionKeys getBusinessObjectDefinitions()

Gets the list of business object definitions that are defined in the system.

Returns:

the retrieved business object definition list.

getBusinessObjectDefinitions

@RequestMapping(value="/businessObjectDefinitions/namespaces/{namespace}",
                method=GET)
 @Secured(value="FN_BUSINESS_OBJECT_DEFINITIONS_ALL_GET")
public BusinessObjectDefinitionKeys getBusinessObjectDefinitions(@PathVariable(value="namespace")
                                                                                                                                                                                                                                  String namespace)

Gets the list of business object definitions that are defined in the system.

Parameters:

namespace - the namespace code

Returns:

the retrieved business object definition list

searchBusinessObjectDefinitions

@RequestMapping(value="/businessObjectDefinitions/search",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_BUSINESS_OBJECT_DEFINITIONS_SEARCH_POST")
public BusinessObjectDefinitionSearchResponse searchBusinessObjectDefinitions(@RequestParam(value="fields",required=false,defaultValue="")
                                                                                                                                                                                                                                                                                                     Set<String> fields,
                                                                                                                                                                                                                                                                                                     @RequestBody
                                                                                                                                                                                                                                                                                                     BusinessObjectDefinitionSearchRequest request)

Searches across all business object definitions that are defined in the system per specified search filters and keys

Parameters:

fields - A comma-separated list of fields to be retrieved with each business object definition entity. Valid options: dataProviderName, shortDescription, displayName

request - the information needed to search across the business object definitions

Returns:

the retrieved business object definition list