org.finra.herd.service

Interface BusinessObjectDefinitionService

All Known Implementing Classes:

BusinessObjectDefinitionServiceImpl

public interface BusinessObjectDefinitionService

The business object definition service.

Method Summary

Modifier and Type	Method and Description
BusinessObjectDefinition	createBusinessObjectDefinition(BusinessObjectDefinitionCreateRequest businessObjectDefinitionCreateRequest) Creates a new business object definition.
BusinessObjectDefinition	deleteBusinessObjectDefinition(BusinessObjectDefinitionKey businessObjectDefinitionKey) Deletes a business object definition for the specified name.
BusinessObjectDefinition	getBusinessObjectDefinition(BusinessObjectDefinitionKey businessObjectDefinitionKey, Boolean includeBusinessObjectDefinitionUpdateHistory) Gets a business object definition for the specified key.
BusinessObjectDefinitionKeys	getBusinessObjectDefinitions() Gets the list of all business object definitions defined in the system.
BusinessObjectDefinitionKeys	getBusinessObjectDefinitions(String namespaceCode) Gets a list of all business object definitions defined in the system for a specified namespace.
boolean	indexSizeCheckValidationBusinessObjectDefinitions(String indexName) Checks the count of business object definitions in the database against the count of business object definitions in the index.
boolean	indexSpotCheckMostRecentValidationBusinessObjectDefinitions(String indexName) Spot check the most recent business object definitions in the search index
boolean	indexSpotCheckPercentageValidationBusinessObjectDefinitions(String indexName) Spot check a random percentage of business object definitions in the search index
Future<Void>	indexValidateAllBusinessObjectDefinitions(String indexName) Validate that the search index contains all business object definitions
BusinessObjectDefinitionSearchResponse	searchBusinessObjectDefinitions(BusinessObjectDefinitionSearchRequest businessObjectDefinitionSearchRequest, Set<String> fields) Searches across all business object definitions that are defined in the system per specified search filters and keys
BusinessObjectDefinition	updateBusinessObjectDefinition(BusinessObjectDefinitionKey businessObjectDefinitionKey, BusinessObjectDefinitionUpdateRequest businessObjectDefinitionUpdateRequest) Updates a business object definition.
BusinessObjectDefinition	updateBusinessObjectDefinitionDescriptiveInformation(BusinessObjectDefinitionKey businessObjectDefinitionKey, BusinessObjectDefinitionDescriptiveInformationUpdateRequest businessObjectDefinitionDescriptiveInformationUpdateRequest) Updates a business object definition descriptive information.
void	updateBusinessObjectDefinitionEntitySampleFile(BusinessObjectDefinitionKey businessObjectDefinitionKey, BusinessObjectDefinitionSampleFileUpdateDto businessObjectDefinitionSampleFileUpdateDto) Update business object definition sample file
void	updateSearchIndexDocumentBusinessObjectDefinition(SearchIndexUpdateDto searchIndexUpdateDto) Updates the search index document representation of the business object definition.

Method Detail

createBusinessObjectDefinition

BusinessObjectDefinition createBusinessObjectDefinition(BusinessObjectDefinitionCreateRequest businessObjectDefinitionCreateRequest)

Creates a new business object definition.

Parameters:

businessObjectDefinitionCreateRequest - the business object definition create request.

Returns:

the created business object definition.

updateBusinessObjectDefinition

BusinessObjectDefinition updateBusinessObjectDefinition(BusinessObjectDefinitionKey businessObjectDefinitionKey,
                                                        BusinessObjectDefinitionUpdateRequest businessObjectDefinitionUpdateRequest)

Updates a business object definition.

Parameters:

businessObjectDefinitionKey - the business object definition key

businessObjectDefinitionUpdateRequest - the business object definition update request

Returns:

the updated business object definition

updateBusinessObjectDefinitionDescriptiveInformation

BusinessObjectDefinition updateBusinessObjectDefinitionDescriptiveInformation(BusinessObjectDefinitionKey businessObjectDefinitionKey,
                                                                              BusinessObjectDefinitionDescriptiveInformationUpdateRequest businessObjectDefinitionDescriptiveInformationUpdateRequest)

Updates a business object definition descriptive information.

Parameters:

businessObjectDefinitionKey - the business object definition key

businessObjectDefinitionDescriptiveInformationUpdateRequest - the business object definition descriptive information update request

Returns:

the updated business object definition

getBusinessObjectDefinition

BusinessObjectDefinition getBusinessObjectDefinition(BusinessObjectDefinitionKey businessObjectDefinitionKey,
                                                     Boolean includeBusinessObjectDefinitionUpdateHistory)

Gets a business object definition for the specified key. This method starts a new transaction.

Parameters:

businessObjectDefinitionKey - the business object definition key

includeBusinessObjectDefinitionUpdateHistory - a flag to indicate if change events are to be included or not

Returns:

the business object definition.

deleteBusinessObjectDefinition

BusinessObjectDefinition deleteBusinessObjectDefinition(BusinessObjectDefinitionKey businessObjectDefinitionKey)

Deletes a business object definition for the specified name.

Parameters:

businessObjectDefinitionKey - the business object definition key

Returns:

the business object definition that was deleted.

getBusinessObjectDefinitions

BusinessObjectDefinitionKeys getBusinessObjectDefinitions()

Gets the list of all business object definitions defined in the system.

Returns:

the business object definition keys.

getBusinessObjectDefinitions

BusinessObjectDefinitionKeys getBusinessObjectDefinitions(String namespaceCode)

Gets a list of all business object definitions defined in the system for a specified namespace.

Parameters:

namespaceCode - the namespace code

Returns:

the business object definition keys

indexSizeCheckValidationBusinessObjectDefinitions

boolean indexSizeCheckValidationBusinessObjectDefinitions(String indexName)

Checks the count of business object definitions in the database against the count of business object definitions in the index.

Parameters:

indexName - the name of the index

Returns:

boolean value true for valid, false otherwise

indexSpotCheckPercentageValidationBusinessObjectDefinitions

boolean indexSpotCheckPercentageValidationBusinessObjectDefinitions(String indexName)

Spot check a random percentage of business object definitions in the search index

Parameters:

indexName - the index name

Returns:

boolean value true for valid, false otherwise

indexSpotCheckMostRecentValidationBusinessObjectDefinitions

boolean indexSpotCheckMostRecentValidationBusinessObjectDefinitions(String indexName)

Spot check the most recent business object definitions in the search index

Parameters:

indexName - the name of the index

Returns:

boolean value true for valid, false otherwise

indexValidateAllBusinessObjectDefinitions

Future<Void> indexValidateAllBusinessObjectDefinitions(String indexName)

Validate that the search index contains all business object definitions

Parameters:

indexName - the name of the index

Returns:

result of an asynchronous computation

searchBusinessObjectDefinitions

BusinessObjectDefinitionSearchResponse searchBusinessObjectDefinitions(BusinessObjectDefinitionSearchRequest businessObjectDefinitionSearchRequest,
                                                                       Set<String> fields)

Searches across all business object definitions that are defined in the system per specified search filters and keys

Returns:

the retrieved business object definition list

updateBusinessObjectDefinitionEntitySampleFile

void updateBusinessObjectDefinitionEntitySampleFile(BusinessObjectDefinitionKey businessObjectDefinitionKey,
                                                    BusinessObjectDefinitionSampleFileUpdateDto businessObjectDefinitionSampleFileUpdateDto)

Update business object definition sample file

Parameters:

businessObjectDefinitionKey - business object definition key

businessObjectDefinitionSampleFileUpdateDto - update dto

updateSearchIndexDocumentBusinessObjectDefinition

void updateSearchIndexDocumentBusinessObjectDefinition(SearchIndexUpdateDto searchIndexUpdateDto)

Updates the search index document representation of the business object definition.

Parameters:

searchIndexUpdateDto - the SearchIndexUpdateDto object