org.finra.herd.service

Interface BusinessObjectDefinitionDescriptionSuggestionService

All Known Implementing Classes:

BusinessObjectDefinitionDescriptionSuggestionServiceImpl

public interface BusinessObjectDefinitionDescriptionSuggestionService

The business object definition description suggestion service.

Method Summary

Modifier and Type	Method and Description
BusinessObjectDefinitionDescriptionSuggestion	acceptBusinessObjectDefinitionDescriptionSuggestion(BusinessObjectDefinitionDescriptionSuggestionAcceptanceRequest request) Accepts the business object definition description suggestion and updates business object definition description.
BusinessObjectDefinitionDescriptionSuggestion	createBusinessObjectDefinitionDescriptionSuggestion(BusinessObjectDefinitionDescriptionSuggestionCreateRequest request) Creates a new business object definition description suggestion.
BusinessObjectDefinitionDescriptionSuggestion	deleteBusinessObjectDefinitionDescriptionSuggestion(BusinessObjectDefinitionDescriptionSuggestionKey key) Deletes an existing business object definition description suggestion by key.
BusinessObjectDefinitionDescriptionSuggestion	getBusinessObjectDefinitionDescriptionSuggestionByKey(BusinessObjectDefinitionDescriptionSuggestionKey key) Gets an existing business object definition description suggestion by key.
BusinessObjectDefinitionDescriptionSuggestionKeys	getBusinessObjectDefinitionDescriptionSuggestions(BusinessObjectDefinitionKey businessObjectDefinitionKey) Gets all existing business object definition description suggestion keys.
BusinessObjectDefinitionDescriptionSuggestionSearchResponse	searchBusinessObjectDefinitionDescriptionSuggestions(BusinessObjectDefinitionDescriptionSuggestionSearchRequest request, Set<String> fields) Search business object definition description suggestions based on the request
BusinessObjectDefinitionDescriptionSuggestion	updateBusinessObjectDefinitionDescriptionSuggestion(BusinessObjectDefinitionDescriptionSuggestionKey key, BusinessObjectDefinitionDescriptionSuggestionUpdateRequest request) Updates an existing business object definition description suggestion by key.

Method Detail

createBusinessObjectDefinitionDescriptionSuggestion

BusinessObjectDefinitionDescriptionSuggestion createBusinessObjectDefinitionDescriptionSuggestion(BusinessObjectDefinitionDescriptionSuggestionCreateRequest request)

Creates a new business object definition description suggestion.

Parameters:

request - the information needed to create the business object definition description suggestion

Returns:

the created user namespace authorization

deleteBusinessObjectDefinitionDescriptionSuggestion

BusinessObjectDefinitionDescriptionSuggestion deleteBusinessObjectDefinitionDescriptionSuggestion(BusinessObjectDefinitionDescriptionSuggestionKey key)

Deletes an existing business object definition description suggestion by key.

Parameters:

key - the business object definition description suggestion key

Returns:

the deleted business object definition description suggestion

getBusinessObjectDefinitionDescriptionSuggestionByKey

BusinessObjectDefinitionDescriptionSuggestion getBusinessObjectDefinitionDescriptionSuggestionByKey(BusinessObjectDefinitionDescriptionSuggestionKey key)

Gets an existing business object definition description suggestion by key.

Parameters:

key - the business object definition description suggestion key

Returns:

the retrieved business object definition description suggestion

getBusinessObjectDefinitionDescriptionSuggestions

BusinessObjectDefinitionDescriptionSuggestionKeys getBusinessObjectDefinitionDescriptionSuggestions(BusinessObjectDefinitionKey businessObjectDefinitionKey)

Gets all existing business object definition description suggestion keys.

Parameters:

businessObjectDefinitionKey - the business object definition key used to get the business object definition suggestion keys

Returns:

the list of retrieved business object definition description suggestion keys

searchBusinessObjectDefinitionDescriptionSuggestions

BusinessObjectDefinitionDescriptionSuggestionSearchResponse searchBusinessObjectDefinitionDescriptionSuggestions(BusinessObjectDefinitionDescriptionSuggestionSearchRequest request,
                                                                                                                 Set<String> fields)

Search business object definition description suggestions based on the request

Parameters:

request - search request

fields - business object definition description suggestions optional fields to return

Returns:

business object definition description suggestion search response

updateBusinessObjectDefinitionDescriptionSuggestion

BusinessObjectDefinitionDescriptionSuggestion updateBusinessObjectDefinitionDescriptionSuggestion(BusinessObjectDefinitionDescriptionSuggestionKey key,
                                                                                                  BusinessObjectDefinitionDescriptionSuggestionUpdateRequest request)

Updates an existing business object definition description suggestion by key.

Parameters:

key - the business object definition description suggestion key

request - the information needed to update the business object definition description suggestion

Returns:

the updated business object definition description suggestion

acceptBusinessObjectDefinitionDescriptionSuggestion

BusinessObjectDefinitionDescriptionSuggestion acceptBusinessObjectDefinitionDescriptionSuggestion(BusinessObjectDefinitionDescriptionSuggestionAcceptanceRequest request)

Accepts the business object definition description suggestion and updates business object definition description.

Parameters:

request - the information needed to accept the business object definition description suggestion.

Returns:

the accepted business object definition description suggestion.