org.finra.herd.rest

Class BusinessObjectDefinitionColumnRestController

java.lang.Object

org.finra.herd.rest.HerdBaseController

org.finra.herd.rest.BusinessObjectDefinitionColumnRestController

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

The REST controller that handles business object definition column requests.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUSINESS_OBJECT_DEFINITION_COLUMNS_URI_PREFIX

Constructor Summary

Constructors

Constructor and Description
BusinessObjectDefinitionColumnRestController()

Method Summary

Modifier and Type	Method and Description
BusinessObjectDefinitionColumn	createBusinessObjectDefinitionColumn(BusinessObjectDefinitionColumnCreateRequest request) Creates a new business object definition column.
BusinessObjectDefinitionColumn	deleteBusinessObjectDefinitionColumn(String namespace, String businessObjectDefinitionName, String businessObjectDefinitionColumnName) Deletes an existing column for the business object definition.
BusinessObjectDefinitionColumn	getBusinessObjectDefinitionColumn(String namespace, String businessObjectDefinitionName, String businessObjectDefinitionColumnName, Boolean includeBusinessObjectDefinitionColumnUpdateHistory) Gets an existing column for the business object definition.
BusinessObjectDefinitionColumnKeys	getBusinessObjectDefinitionColumns(String namespace, String businessObjectDefinitionName) Gets a list of keys for all existing business object definition columns for a specific business object definition.
BusinessObjectDefinitionColumnSearchResponse	searchBusinessObjectDefinitionColumns(Set<String> fields, BusinessObjectDefinitionColumnSearchRequest request) Retrieve a list of business object definition columns meeting the search criteria filters and fields request.
BusinessObjectDefinitionColumn	updateBusinessObjectDefinitionColumn(String namespace, String businessObjectDefinitionName, String businessObjectDefinitionColumnName, BusinessObjectDefinitionColumnUpdateRequest request) Updates an existing column for the business object definition.

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_COLUMNS_URI_PREFIX

public static final String BUSINESS_OBJECT_DEFINITION_COLUMNS_URI_PREFIX

See Also:

Constant Field Values

Constructor Detail

BusinessObjectDefinitionColumnRestController

public BusinessObjectDefinitionColumnRestController()

Method Detail

createBusinessObjectDefinitionColumn

@RequestMapping(value="/businessObjectDefinitionColumns",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_BUSINESS_OBJECT_DEFINITION_COLUMNS_POST")
public BusinessObjectDefinitionColumn createBusinessObjectDefinitionColumn(@RequestBody
                                                                                                                                                                                                                                                                                                 BusinessObjectDefinitionColumnCreateRequest request)

Creates a new business object definition column.

Requires WRITE or WRITE_DESCRIPTIVE_CONTENT permission on namespace

Parameters:

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

Returns:

the newly created business object definition column

getBusinessObjectDefinitionColumn

@RequestMapping(value="/businessObjectDefinitionColumns/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectDefinitionColumnNames/{businessObjectDefinitionColumnName}",
                method=GET)
 @Secured(value="FN_BUSINESS_OBJECT_DEFINITION_COLUMNS_GET")
public BusinessObjectDefinitionColumn getBusinessObjectDefinitionColumn(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                                                                                        String namespace,
                                                                                                                                                                                                                                                                                                                                                                                        @PathVariable(value="businessObjectDefinitionName")
                                                                                                                                                                                                                                                                                                                                                                                        String businessObjectDefinitionName,
                                                                                                                                                                                                                                                                                                                                                                                        @PathVariable(value="businessObjectDefinitionColumnName")
                                                                                                                                                                                                                                                                                                                                                                                        String businessObjectDefinitionColumnName,
                                                                                                                                                                                                                                                                                                                                                                                        @RequestParam(value="includeBusinessObjectDefinitionColumnUpdateHistory",required=false)
                                                                                                                                                                                                                                                                                                                                                                                        Boolean includeBusinessObjectDefinitionColumnUpdateHistory)

Gets an existing column for the business object definition.

Parameters:

namespace - the namespace of the business object definition

businessObjectDefinitionName - the name of the business object definition

businessObjectDefinitionColumnName - the name of the business object definition column

includeBusinessObjectDefinitionColumnUpdateHistory - the boolean flag to determine whether or not to include business object definition column update history in the get results

Returns:

the business object definition column that got updated

updateBusinessObjectDefinitionColumn

@RequestMapping(value="/businessObjectDefinitionColumns/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectDefinitionColumnNames/{businessObjectDefinitionColumnName}",
                method=PUT,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_BUSINESS_OBJECT_DEFINITION_COLUMNS_PUT")
public BusinessObjectDefinitionColumn updateBusinessObjectDefinitionColumn(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                                                                                                                                                            String namespace,
                                                                                                                                                                                                                                                                                                                                                                                                                                                            @PathVariable(value="businessObjectDefinitionName")
                                                                                                                                                                                                                                                                                                                                                                                                                                                            String businessObjectDefinitionName,
                                                                                                                                                                                                                                                                                                                                                                                                                                                            @PathVariable(value="businessObjectDefinitionColumnName")
                                                                                                                                                                                                                                                                                                                                                                                                                                                            String businessObjectDefinitionColumnName,
                                                                                                                                                                                                                                                                                                                                                                                                                                                            @RequestBody
                                                                                                                                                                                                                                                                                                                                                                                                                                                            BusinessObjectDefinitionColumnUpdateRequest request)

Updates an existing column for the business object definition.

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

businessObjectDefinitionColumnName - the name of the business object definition column

request - the request information needed to update the business object definition column

Returns:

the business object definition column

deleteBusinessObjectDefinitionColumn

@RequestMapping(value="/businessObjectDefinitionColumns/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectDefinitionColumnNames/{businessObjectDefinitionColumnName}",
                method=DELETE)
 @Secured(value="FN_BUSINESS_OBJECT_DEFINITION_COLUMNS_DELETE")
public BusinessObjectDefinitionColumn deleteBusinessObjectDefinitionColumn(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                                                                                                 String namespace,
                                                                                                                                                                                                                                                                                                                                                                                                 @PathVariable(value="businessObjectDefinitionName")
                                                                                                                                                                                                                                                                                                                                                                                                 String businessObjectDefinitionName,
                                                                                                                                                                                                                                                                                                                                                                                                 @PathVariable(value="businessObjectDefinitionColumnName")
                                                                                                                                                                                                                                                                                                                                                                                                 String businessObjectDefinitionColumnName)

Deletes an existing column for the business object definition.

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

businessObjectDefinitionColumnName - the name of the business object definition column

Returns:

the business object definition column that got deleted

getBusinessObjectDefinitionColumns

@RequestMapping(value="/businessObjectDefinitionColumns/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}",
                method=GET)
 @Secured(value="FN_BUSINESS_OBJECT_DEFINITION_COLUMNS_ALL_GET")
public BusinessObjectDefinitionColumnKeys getBusinessObjectDefinitionColumns(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                        String namespace,
                                                                                                                                                                                                                                                                                                                        @PathVariable(value="businessObjectDefinitionName")
                                                                                                                                                                                                                                                                                                                        String businessObjectDefinitionName)

Gets a list of keys for all existing business object definition columns for a specific 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 column keys

searchBusinessObjectDefinitionColumns

@RequestMapping(value="/businessObjectDefinitionColumns/search",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_BUSINESS_OBJECT_DEFINITION_COLUMNS_SEARCH_POST")
public BusinessObjectDefinitionColumnSearchResponse searchBusinessObjectDefinitionColumns(@RequestParam(value="fields",required=false,defaultValue="")
                                                                                                                                                                                                                                                                                                                              Set<String> fields,
                                                                                                                                                                                                                                                                                                                              @RequestBody
                                                                                                                                                                                                                                                                                                                              BusinessObjectDefinitionColumnSearchRequest request)

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

Parameters:

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

fields - the field options for the business object definition columns search response. The valid field options are: description, schemaColumnName

Returns:

the list of business object definition columns