org.finra.herd.service

Interface BusinessObjectDefinitionColumnService

All Known Implementing Classes:

BusinessObjectDefinitionColumnServiceImpl

public interface BusinessObjectDefinitionColumnService

The business object definition column service.

Method Summary

Modifier and Type	Method and Description
BusinessObjectDefinitionColumn	createBusinessObjectDefinitionColumn(BusinessObjectDefinitionColumnCreateRequest businessObjectDefinitionColumnCreateRequest) Creates a new business object definition column.
BusinessObjectDefinitionColumn	deleteBusinessObjectDefinitionColumn(BusinessObjectDefinitionColumnKey businessObjectDefinitionColumnKey) Deletes an existing business object definition column by key.
BusinessObjectDefinitionColumn	getBusinessObjectDefinitionColumn(BusinessObjectDefinitionColumnKey businessObjectDefinitionColumnKey, Boolean includeBusinessObjectDefinitionColumnUpdateHistory) Gets an existing business object definition column by key.
BusinessObjectDefinitionColumnKeys	getBusinessObjectDefinitionColumns(BusinessObjectDefinitionKey businessObjectDefinitionKey) Gets a list of keys for all existing business object definition columns.
BusinessObjectDefinitionColumnSearchResponse	searchBusinessObjectDefinitionColumns(BusinessObjectDefinitionColumnSearchRequest request, Set<String> fields) Search business object definition columns based on the request
BusinessObjectDefinitionColumn	updateBusinessObjectDefinitionColumn(BusinessObjectDefinitionColumnKey businessObjectDefinitionColumnKey, BusinessObjectDefinitionColumnUpdateRequest businessObjectDefinitionColumnUpdateRequest) Updates an existing business object definition column by key.

Method Detail

createBusinessObjectDefinitionColumn

BusinessObjectDefinitionColumn createBusinessObjectDefinitionColumn(BusinessObjectDefinitionColumnCreateRequest businessObjectDefinitionColumnCreateRequest)

Creates a new business object definition column.

Parameters:

businessObjectDefinitionColumnCreateRequest - the information needed to create a business object definition column

Returns:

the newly created business object definition column

getBusinessObjectDefinitionColumn

BusinessObjectDefinitionColumn getBusinessObjectDefinitionColumn(BusinessObjectDefinitionColumnKey businessObjectDefinitionColumnKey,
                                                                 Boolean includeBusinessObjectDefinitionColumnUpdateHistory)

Gets an existing business object definition column by key.

Parameters:

businessObjectDefinitionColumnKey - the business object definition column key

includeBusinessObjectDefinitionColumnUpdateHistory - the boolean flag to determine whether or not to include business object definition column update history in the get results

Returns:

the business object definition column information

updateBusinessObjectDefinitionColumn

BusinessObjectDefinitionColumn updateBusinessObjectDefinitionColumn(BusinessObjectDefinitionColumnKey businessObjectDefinitionColumnKey,
                                                                    BusinessObjectDefinitionColumnUpdateRequest businessObjectDefinitionColumnUpdateRequest)

Updates an existing business object definition column by key.

Parameters:

businessObjectDefinitionColumnKey - the business object definition column key

businessObjectDefinitionColumnUpdateRequest - the information needed to update a business object definition column

Returns:

the business object definition column information

deleteBusinessObjectDefinitionColumn

BusinessObjectDefinitionColumn deleteBusinessObjectDefinitionColumn(BusinessObjectDefinitionColumnKey businessObjectDefinitionColumnKey)

Deletes an existing business object definition column by key.

Parameters:

businessObjectDefinitionColumnKey - the business object definition column key

Returns:

the business object definition column information for the attribute that got deleted

getBusinessObjectDefinitionColumns

BusinessObjectDefinitionColumnKeys getBusinessObjectDefinitionColumns(BusinessObjectDefinitionKey businessObjectDefinitionKey)

Gets a list of keys for all existing business object definition columns.

Parameters:

businessObjectDefinitionKey - the business object definition key

Returns:

the list of business object definition column keys

searchBusinessObjectDefinitionColumns

BusinessObjectDefinitionColumnSearchResponse searchBusinessObjectDefinitionColumns(BusinessObjectDefinitionColumnSearchRequest request,
                                                                                   Set<String> fields)

Search business object definition columns based on the request

Parameters:

request - search request

fields - business object data columns optional fields to return

Returns:

business object definition column search response