org.finra.herd.rest

Class BusinessObjectFormatExternalInterfaceRestController

java.lang.Object

org.finra.herd.rest.BusinessObjectFormatExternalInterfaceRestController

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

The REST controller that handles business object format to external interface mapping REST requests.

Constructor Summary

Constructors

Constructor and Description
BusinessObjectFormatExternalInterfaceRestController()

Method Summary

Modifier and Type	Method and Description
BusinessObjectFormatExternalInterface	createBusinessObjectFormatExternalInterface(BusinessObjectFormatExternalInterfaceCreateRequest businessObjectFormatExternalInterfaceCreateRequest) Creates a new business object format to external interface mapping that is identified by namespace, business object definition name, business object format usage, business object format file type, and external interface name.
BusinessObjectFormatExternalInterface	deleteBusinessObjectFormatExternalInterface(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, String externalInterfaceName) Deletes an existing business object format to external interface mapping mapping based on the specified parameters.
BusinessObjectFormatExternalInterface	getBusinessObjectFormatExternalInterface(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, String externalInterfaceName) Retrieves an existing business object format to external interface mapping mapping based on the specified parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

BusinessObjectFormatExternalInterfaceRestController

public BusinessObjectFormatExternalInterfaceRestController()

Method Detail

createBusinessObjectFormatExternalInterface

@RequestMapping(value="/businessObjectFormatExternalInterfaces",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_BUSINESS_OBJECT_FORMAT_EXTERNAL_INTERFACES_POST")
public BusinessObjectFormatExternalInterface createBusinessObjectFormatExternalInterface(@RequestBody
                                                                                                                                                                                                                                                                                                                              BusinessObjectFormatExternalInterfaceCreateRequest businessObjectFormatExternalInterfaceCreateRequest)

Creates a new business object format to external interface mapping that is identified by namespace, business object definition name, business object format usage, business object format file type, and external interface name.

Parameters:

businessObjectFormatExternalInterfaceCreateRequest - the information needed to create a business object format to external interface mapping

Returns:

the created business object format to external interface mapping

deleteBusinessObjectFormatExternalInterface

@RequestMapping(value="/businessObjectFormatExternalInterfaces/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/externalInterfaceNames/{externalInterfaceName}",
                method=DELETE)
 @Secured(value="FN_BUSINESS_OBJECT_FORMAT_EXTERNAL_INTERFACES_DELETE")
public BusinessObjectFormatExternalInterface deleteBusinessObjectFormatExternalInterface(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        String namespace,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @PathVariable(value="businessObjectDefinitionName")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        String businessObjectDefinitionName,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @PathVariable(value="businessObjectFormatUsage")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        String businessObjectFormatUsage,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @PathVariable(value="businessObjectFormatFileType")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        String businessObjectFormatFileType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @PathVariable(value="externalInterfaceName")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        String externalInterfaceName)

Deletes an existing business object format to external interface mapping mapping based on the specified parameters.

Parameters:

namespace - the namespace

businessObjectDefinitionName - the business object definition name

businessObjectFormatUsage - the business object format usage

businessObjectFormatFileType - the business object format file type

externalInterfaceName - the external interface name

Returns:

the deleted business object format to external interface mapping

getBusinessObjectFormatExternalInterface

@RequestMapping(value="/businessObjectFormatExternalInterfaces/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/externalInterfaceNames/{externalInterfaceName}",
                method=GET)
 @Secured(value="FN_BUSINESS_OBJECT_FORMAT_EXTERNAL_INTERFACES_GET")
public BusinessObjectFormatExternalInterface getBusinessObjectFormatExternalInterface(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               String namespace,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               @PathVariable(value="businessObjectDefinitionName")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               String businessObjectDefinitionName,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               @PathVariable(value="businessObjectFormatUsage")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               String businessObjectFormatUsage,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               @PathVariable(value="businessObjectFormatFileType")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               String businessObjectFormatFileType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               @PathVariable(value="externalInterfaceName")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               String externalInterfaceName)

Retrieves an existing business object format to external interface mapping mapping based on the specified parameters.

Parameters:

namespace - the namespace

businessObjectDefinitionName - the business object definition name

businessObjectFormatUsage - the business object format usage

businessObjectFormatFileType - the business object format file type

externalInterfaceName - the external interface name

Returns:

the retrieved business object format to external interface mapping