org.finra.herd.rest

Class RelationalTableRegistrationRestController

java.lang.Object

org.finra.herd.rest.HerdBaseController

org.finra.herd.rest.RelationalTableRegistrationRestController

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

Constructor Summary

Constructors

Constructor and Description
RelationalTableRegistrationRestController()

Method Summary

Modifier and Type	Method and Description
BusinessObjectData	createRelationalTableRegistration(RelationalTableRegistrationCreateRequest relationalTableRegistrationCreateRequest, Boolean appendToExistingBusinessObjectDefinition) Creates relational table registration
RelationalTableRegistrationDeleteResponse	deleteRelationalTableRegistration(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage) Delete a relational table registration.

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

RelationalTableRegistrationRestController

public RelationalTableRegistrationRestController()

Method Detail

createRelationalTableRegistration

@RequestMapping(value="/relationalTableRegistrations",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_RELATIONAL_TABLE_REGISTRATIONS_POST")
public BusinessObjectData createRelationalTableRegistration(@RequestBody
                                                                                                                                                                                                                                                                           RelationalTableRegistrationCreateRequest relationalTableRegistrationCreateRequest,
                                                                                                                                                                                                                                                                           @RequestParam(value="appendToExistingBusinessObjectDefinition",required=false,defaultValue="false")
                                                                                                                                                                                                                                                                           Boolean appendToExistingBusinessObjectDefinition)

Creates relational table registration

Parameters:

relationalTableRegistrationCreateRequest - relational table registration create request

appendToExistingBusinessObjectDefinition - boolean flag that determines if the format should be appended to an existing business object definition

Returns:

business object data

deleteRelationalTableRegistration

@RequestMapping(value="/relationalTableRegistrations/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}",
                method=DELETE)
 @Secured(value="FN_RELATIONAL_TABLE_REGISTRATIONS_DELETE")
public RelationalTableRegistrationDeleteResponse deleteRelationalTableRegistration(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                                                                                String namespace,
                                                                                                                                                                                                                                                                                                                                                                                @PathVariable(value="businessObjectDefinitionName")
                                                                                                                                                                                                                                                                                                                                                                                String businessObjectDefinitionName,
                                                                                                                                                                                                                                                                                                                                                                                @PathVariable(value="businessObjectFormatUsage")
                                                                                                                                                                                                                                                                                                                                                                                String businessObjectFormatUsage)

Delete a relational table registration.

Parameters:

namespace - the namespace code

businessObjectDefinitionName - the business object definition name

businessObjectFormatUsage - the business object format usage

Returns:

business object data