org.finra.herd.service

Interface ExternalInterfaceService

All Known Implementing Classes:

ExternalInterfaceServiceImpl

public interface ExternalInterfaceService

The external interface service.

Method Summary

Modifier and Type	Method and Description
ExternalInterface	createExternalInterface(ExternalInterfaceCreateRequest externalInterfaceCreateRequest) Creates a new external interface.
ExternalInterface	deleteExternalInterface(ExternalInterfaceKey externalInterfaceKey) Deletes an external interface for the specified name.
ExternalInterface	getExternalInterface(ExternalInterfaceKey externalInterfaceKey) Gets an external interface for the specified key.
ExternalInterfaceKeys	getExternalInterfaces() Gets a list of external interface keys for all external interfaces defined in the system.
ExternalInterface	updateExternalInterface(ExternalInterfaceKey externalInterfaceKey, ExternalInterfaceUpdateRequest externalInterfaceUpdateRequest) Updates an existing external interface.

Method Detail

createExternalInterface

ExternalInterface createExternalInterface(ExternalInterfaceCreateRequest externalInterfaceCreateRequest)

Creates a new external interface.

Parameters:

externalInterfaceCreateRequest - the external interface create request

Returns:

the created external interface

getExternalInterface

ExternalInterface getExternalInterface(ExternalInterfaceKey externalInterfaceKey)

Gets an external interface for the specified key.

Parameters:

externalInterfaceKey - the external interface key

Returns:

the external interface

deleteExternalInterface

ExternalInterface deleteExternalInterface(ExternalInterfaceKey externalInterfaceKey)

Deletes an external interface for the specified name.

Parameters:

externalInterfaceKey - the external interface key

Returns:

the external interface that was deleted

getExternalInterfaces

ExternalInterfaceKeys getExternalInterfaces()

Gets a list of external interface keys for all external interfaces defined in the system.

Returns:

the external interface keys

updateExternalInterface

ExternalInterface updateExternalInterface(ExternalInterfaceKey externalInterfaceKey,
                                          ExternalInterfaceUpdateRequest externalInterfaceUpdateRequest)

Updates an existing external interface.

Parameters:

externalInterfaceKey - the external interface key

externalInterfaceUpdateRequest - the external interface update request

Returns:

the created external interface