org.finra.herd.rest

Class BusinessObjectFormatExternalInterfaceDescriptiveInformationRestController

java.lang.Object

org.finra.herd.rest.BusinessObjectFormatExternalInterfaceDescriptiveInformationRestController

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

The REST controller that handles business object format external interface descriptive information REST requests.

Constructor Summary

Constructors

Constructor and Description
BusinessObjectFormatExternalInterfaceDescriptiveInformationRestController()

Method Summary

Modifier and Type	Method and Description
BusinessObjectFormatExternalInterfaceDescriptiveInformation	getBusinessObjectFormatExternalInterface(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, String externalInterfaceName) Retrieves the existing business object format external interface descriptive information 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

BusinessObjectFormatExternalInterfaceDescriptiveInformationRestController

public BusinessObjectFormatExternalInterfaceDescriptiveInformationRestController()

Method Detail

getBusinessObjectFormatExternalInterface

@RequestMapping(value="/businessObjectFormatExternalInterfaceDescriptiveInformation/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/externalInterfaceNames/{externalInterfaceName}",
                method=GET)
 @Secured(value="FN_BUSINESS_OBJECT_FORMAT_EXTERNAL_INTERFACE_DESCRIPTIVE_INFORMATION_GET")
public BusinessObjectFormatExternalInterfaceDescriptiveInformation 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 the existing business object format external interface descriptive information 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 external interface descriptive information