org.finra.herd.service.impl

Class BusinessObjectDefinitionServiceImpl

java.lang.Object

org.finra.herd.service.impl.BusinessObjectDefinitionServiceImpl

All Implemented Interfaces:

BusinessObjectDefinitionService, FacetFieldValidationService, SearchableService

@Service
 @Transactional(value="herdTransactionManager")
public class BusinessObjectDefinitionServiceImpl
extends Object
implements BusinessObjectDefinitionService, SearchableService, FacetFieldValidationService

The business object definition service implementation.

Constructor Summary

Constructors

Constructor and Description
BusinessObjectDefinitionServiceImpl()

Method Summary

Modifier and Type	Method and Description
BusinessObjectDefinition	createBusinessObjectDefinition(BusinessObjectDefinitionCreateRequest request) Creates a new business object definition.
BusinessObjectDefinition	deleteBusinessObjectDefinition(BusinessObjectDefinitionKey businessObjectDefinitionKey) Deletes a business object definition for the specified name.
BusinessObjectDefinition	getBusinessObjectDefinition(BusinessObjectDefinitionKey businessObjectDefinitionKey) Gets a business object definition for the specified key.
protected BusinessObjectDefinition	getBusinessObjectDefinitionImpl(BusinessObjectDefinitionKey businessObjectDefinitionKey) 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.
Set<String>	getValidFacetFields() Returns valid facet fields.
Set<String>	getValidSearchResponseFields() Returns valid search response fields.
BusinessObjectDefinitionIndexSearchResponse	indexSearchBusinessObjectDefinitions(BusinessObjectDefinitionIndexSearchRequest searchRequest, Set<String> fieldsRequested) Searches across all business object definitions that are in search index per specified search filters and keys
boolean	indexSizeCheckValidationBusinessObjectDefinitions() Checks the count of business object definitions in the database against the count of business object definitions in the index.
boolean	indexSpotCheckMostRecentValidationBusinessObjectDefinitions() Spot check the most recent business object definitions in the search index
boolean	indexSpotCheckPercentageValidationBusinessObjectDefinitions() Spot check a random percentage of business object definitions in the search index
Future<Void>	indexValidateAllBusinessObjectDefinitions() Validate that the search index contains all business object definitions
BusinessObjectDefinitionSearchResponse	searchBusinessObjectDefinitions(BusinessObjectDefinitionSearchRequest request, 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 request) Updates a business object definition.
BusinessObjectDefinition	updateBusinessObjectDefinitionDescriptiveInformation(BusinessObjectDefinitionKey businessObjectDefinitionKey, BusinessObjectDefinitionDescriptiveInformationUpdateRequest request) 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.finra.herd.service.SearchableService

validateSearchResponseFields

Methods inherited from interface org.finra.herd.service.FacetFieldValidationService

validateFacetFields

Constructor Detail

BusinessObjectDefinitionServiceImpl

public BusinessObjectDefinitionServiceImpl()

Method Detail

createBusinessObjectDefinition

@PublishJmsMessages
 @NamespacePermission(fields="#request.namespace",
                     permissions=WRITE)
public BusinessObjectDefinition createBusinessObjectDefinition(BusinessObjectDefinitionCreateRequest request)

Description copied from interface: BusinessObjectDefinitionService

Creates a new business object definition.

Specified by:

createBusinessObjectDefinition in interface BusinessObjectDefinitionService

Parameters:

request - the business object definition create request.

Returns:

the created business object definition.

indexSizeCheckValidationBusinessObjectDefinitions

public boolean indexSizeCheckValidationBusinessObjectDefinitions()

Description copied from interface: BusinessObjectDefinitionService

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

Specified by:

indexSizeCheckValidationBusinessObjectDefinitions in interface BusinessObjectDefinitionService

Returns:

boolean value true for valid, false otherwise

indexSpotCheckPercentageValidationBusinessObjectDefinitions

public boolean indexSpotCheckPercentageValidationBusinessObjectDefinitions()

Description copied from interface: BusinessObjectDefinitionService

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

Specified by:

indexSpotCheckPercentageValidationBusinessObjectDefinitions in interface BusinessObjectDefinitionService

Returns:

boolean value true for valid, false otherwise

indexSpotCheckMostRecentValidationBusinessObjectDefinitions

public boolean indexSpotCheckMostRecentValidationBusinessObjectDefinitions()

Description copied from interface: BusinessObjectDefinitionService

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

Specified by:

indexSpotCheckMostRecentValidationBusinessObjectDefinitions in interface BusinessObjectDefinitionService

Returns:

boolean value true for valid, false otherwise

indexValidateAllBusinessObjectDefinitions

@Async
public Future<Void> indexValidateAllBusinessObjectDefinitions()

Description copied from interface: BusinessObjectDefinitionService

Validate that the search index contains all business object definitions

Specified by:

indexValidateAllBusinessObjectDefinitions in interface BusinessObjectDefinitionService

Returns:

result of an asynchronous computation

updateBusinessObjectDefinition

@PublishJmsMessages
 @NamespacePermission(fields="#businessObjectDefinitionKey.namespace",
                     permissions=WRITE)
public BusinessObjectDefinition updateBusinessObjectDefinition(BusinessObjectDefinitionKey businessObjectDefinitionKey,
                                                                                                                                                                                                  BusinessObjectDefinitionUpdateRequest request)

Description copied from interface: BusinessObjectDefinitionService

Updates a business object definition.

Specified by:

updateBusinessObjectDefinition in interface BusinessObjectDefinitionService

Parameters:

businessObjectDefinitionKey - the business object definition key

request - the business object definition update request

Returns:

the updated business object definition

updateBusinessObjectDefinitionDescriptiveInformation

@PublishJmsMessages
public BusinessObjectDefinition updateBusinessObjectDefinitionDescriptiveInformation(BusinessObjectDefinitionKey businessObjectDefinitionKey,
                                                                                                         BusinessObjectDefinitionDescriptiveInformationUpdateRequest request)

Description copied from interface: BusinessObjectDefinitionService

Updates a business object definition descriptive information.

Specified by:

updateBusinessObjectDefinitionDescriptiveInformation in interface BusinessObjectDefinitionService

Parameters:

businessObjectDefinitionKey - the business object definition key

request - the business object definition descriptive information update request

Returns:

the updated business object definition

getBusinessObjectDefinition

@Transactional(propagation=REQUIRES_NEW)
public BusinessObjectDefinition getBusinessObjectDefinition(BusinessObjectDefinitionKey businessObjectDefinitionKey)

Description copied from interface: BusinessObjectDefinitionService

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

Specified by:

getBusinessObjectDefinition in interface BusinessObjectDefinitionService

Parameters:

businessObjectDefinitionKey - the business object definition key

Returns:

the business object definition.

getBusinessObjectDefinitionImpl

protected BusinessObjectDefinition getBusinessObjectDefinitionImpl(BusinessObjectDefinitionKey businessObjectDefinitionKey)

Gets a business object definition for the specified key.

Parameters:

businessObjectDefinitionKey - the business object definition key

Returns:

the business object definition.

deleteBusinessObjectDefinition

@PublishJmsMessages
 @NamespacePermission(fields="#businessObjectDefinitionKey.namespace",
                     permissions=WRITE)
public BusinessObjectDefinition deleteBusinessObjectDefinition(BusinessObjectDefinitionKey businessObjectDefinitionKey)

Description copied from interface: BusinessObjectDefinitionService

Deletes a business object definition for the specified name.

Specified by:

deleteBusinessObjectDefinition in interface BusinessObjectDefinitionService

Parameters:

businessObjectDefinitionKey - the business object definition key

Returns:

the business object definition that was deleted.

getBusinessObjectDefinitions

public BusinessObjectDefinitionKeys getBusinessObjectDefinitions()

Description copied from interface: BusinessObjectDefinitionService

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

Specified by:

getBusinessObjectDefinitions in interface BusinessObjectDefinitionService

Returns:

the business object definition keys.

getBusinessObjectDefinitions

public BusinessObjectDefinitionKeys getBusinessObjectDefinitions(String namespaceCode)

Description copied from interface: BusinessObjectDefinitionService

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

Specified by:

getBusinessObjectDefinitions in interface BusinessObjectDefinitionService

Parameters:

namespaceCode - the namespace code

Returns:

the business object definition keys

getValidFacetFields

public Set<String> getValidFacetFields()

Description copied from interface: FacetFieldValidationService

Returns valid facet fields.

Specified by:

getValidFacetFields in interface FacetFieldValidationService

Returns:

the set of valid facet fields

indexSearchBusinessObjectDefinitions

public BusinessObjectDefinitionIndexSearchResponse indexSearchBusinessObjectDefinitions(BusinessObjectDefinitionIndexSearchRequest searchRequest,
                                                                                        Set<String> fieldsRequested)

Description copied from interface: BusinessObjectDefinitionService

Searches across all business object definitions that are in search index per specified search filters and keys

Specified by:

indexSearchBusinessObjectDefinitions in interface BusinessObjectDefinitionService

Returns:

the retrieved business object definition list

searchBusinessObjectDefinitions

public BusinessObjectDefinitionSearchResponse searchBusinessObjectDefinitions(BusinessObjectDefinitionSearchRequest request,
                                                                              Set<String> fields)

Description copied from interface: BusinessObjectDefinitionService

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

Specified by:

searchBusinessObjectDefinitions in interface BusinessObjectDefinitionService

Returns:

the retrieved business object definition list

getValidSearchResponseFields

public Set<String> getValidSearchResponseFields()

Description copied from interface: SearchableService

Returns valid search response fields.

Specified by:

getValidSearchResponseFields in interface SearchableService

Returns:

the set of valid search response fields

updateBusinessObjectDefinitionEntitySampleFile

@PublishJmsMessages
public void updateBusinessObjectDefinitionEntitySampleFile(BusinessObjectDefinitionKey businessObjectDefinitionKey,
                                                                               BusinessObjectDefinitionSampleFileUpdateDto businessObjectDefinitionSampleFileUpdateDto)

Description copied from interface: BusinessObjectDefinitionService

Update business object definition sample file

Specified by:

updateBusinessObjectDefinitionEntitySampleFile in interface BusinessObjectDefinitionService

Parameters:

businessObjectDefinitionKey - business object definition key

businessObjectDefinitionSampleFileUpdateDto - update dto

updateSearchIndexDocumentBusinessObjectDefinition

public void updateSearchIndexDocumentBusinessObjectDefinition(SearchIndexUpdateDto searchIndexUpdateDto)

Description copied from interface: BusinessObjectDefinitionService

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

Specified by:

updateSearchIndexDocumentBusinessObjectDefinition in interface BusinessObjectDefinitionService

Parameters:

searchIndexUpdateDto - the SearchIndexUpdateDto object