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.

Field Summary

Fields

Modifier and Type	Field and Description
static int	UPDATE_SEARCH_INDEX_DOCUMENT_CHUNK_SIZE The size of the chunks to use when updating search index documents based on a list of ids.

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.
protected BusinessObjectDefinition	createBusinessObjectDefinitionImpl(BusinessObjectDefinitionCreateRequest request) Creates a new business object definition.
BusinessObjectDefinition	deleteBusinessObjectDefinition(BusinessObjectDefinitionKey businessObjectDefinitionKey) Deletes a business object definition for the specified name.
protected BusinessObjectDefinition	deleteBusinessObjectDefinitionImpl(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.
protected BusinessObjectDefinition	getBusinessObjectDefinitionImpl(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.
Set<String>	getValidFacetFields() Returns valid facet fields.
Set<String>	getValidSearchResponseFields() Returns valid search response fields.
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.
protected BusinessObjectDefinition	updateBusinessObjectDefinitionDescriptiveInformationImpl(BusinessObjectDefinitionKey businessObjectDefinitionKey, BusinessObjectDefinitionDescriptiveInformationUpdateRequest request) Updates a business object definition descriptive information.
void	updateBusinessObjectDefinitionEntitySampleFile(BusinessObjectDefinitionKey businessObjectDefinitionKey, BusinessObjectDefinitionSampleFileUpdateDto businessObjectDefinitionSampleFileUpdateDto) Update business object definition sample file
protected BusinessObjectDefinition	updateBusinessObjectDefinitionImpl(BusinessObjectDefinitionKey businessObjectDefinitionKey, BusinessObjectDefinitionUpdateRequest request) Updates a business object definition.
void	updateSearchIndexDocumentBusinessObjectDefinition(SearchIndexUpdateDto searchIndexUpdateDto) Updates the search index document representation of the business object definition.
protected void	updateSearchIndexDocumentBusinessObjectDefinitionImpl(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

Field Detail

UPDATE_SEARCH_INDEX_DOCUMENT_CHUNK_SIZE

public static final int UPDATE_SEARCH_INDEX_DOCUMENT_CHUNK_SIZE

The size of the chunks to use when updating search index documents based on a list of ids.

See Also:

Constant Field Values

Constructor Detail

BusinessObjectDefinitionServiceImpl

public BusinessObjectDefinitionServiceImpl()

Method Detail

createBusinessObjectDefinition

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

Creates a new business object definition.

This implementation starts a new transaction.

Specified by:

createBusinessObjectDefinition in interface BusinessObjectDefinitionService

Parameters:

request - the business object definition create request.

Returns:

the created business object definition.

createBusinessObjectDefinitionImpl

protected BusinessObjectDefinition createBusinessObjectDefinitionImpl(BusinessObjectDefinitionCreateRequest request)

Creates a new business object definition.

Parameters:

request - the business object definition create request

Returns:

the created business object definition

updateBusinessObjectDefinition

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

Updates a business object definition.

This implementation starts a new transaction.

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

updateBusinessObjectDefinitionImpl

protected BusinessObjectDefinition updateBusinessObjectDefinitionImpl(BusinessObjectDefinitionKey businessObjectDefinitionKey,
                                                                      BusinessObjectDefinitionUpdateRequest request)

Updates a business object definition.

Parameters:

businessObjectDefinitionKey - the business object definition key

request - the business object definition update request

Returns:

the updated business object definition

updateBusinessObjectDefinitionDescriptiveInformation

@NamespacePermission(fields="#businessObjectDefinitionKey.namespace",
                     permissions={WRITE_DESCRIPTIVE_CONTENT,WRITE})
 @Transactional(propagation=REQUIRES_NEW)
public BusinessObjectDefinition updateBusinessObjectDefinitionDescriptiveInformation(BusinessObjectDefinitionKey businessObjectDefinitionKey,
                                                                                                                                                                                                                                                                         BusinessObjectDefinitionDescriptiveInformationUpdateRequest request)

Updates a business object definition descriptive information.

This implementation starts a new transaction.

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

updateBusinessObjectDefinitionDescriptiveInformationImpl

protected BusinessObjectDefinition updateBusinessObjectDefinitionDescriptiveInformationImpl(BusinessObjectDefinitionKey businessObjectDefinitionKey,
                                                                                            BusinessObjectDefinitionDescriptiveInformationUpdateRequest request)

Updates a business object definition descriptive information.

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,
                                                                                                     Boolean includeBusinessObjectDefinitionUpdateHistory)

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

This implementation starts a new transaction.

Specified by:

getBusinessObjectDefinition in interface BusinessObjectDefinitionService

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.

getBusinessObjectDefinitionImpl

protected BusinessObjectDefinition getBusinessObjectDefinitionImpl(BusinessObjectDefinitionKey businessObjectDefinitionKey,
                                                                   Boolean includeBusinessObjectDefinitionUpdateHistory)

Gets a business object definition for the specified key.

Parameters:

businessObjectDefinitionKey - the business object definition key

includeBusinessObjectDefinitionUpdateHistory - a flag to include change event information or not

Returns:

the business object definition.

deleteBusinessObjectDefinition

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

Deletes a business object definition for the specified name.

This implementation starts a new transaction.

Specified by:

deleteBusinessObjectDefinition in interface BusinessObjectDefinitionService

Parameters:

businessObjectDefinitionKey - the business object definition key

Returns:

the business object definition that was deleted.

deleteBusinessObjectDefinitionImpl

protected BusinessObjectDefinition deleteBusinessObjectDefinitionImpl(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

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

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

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

@Transactional(propagation=REQUIRES_NEW)
public void updateSearchIndexDocumentBusinessObjectDefinition(SearchIndexUpdateDto searchIndexUpdateDto)

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

This implementation starts a new transaction.

Specified by:

updateSearchIndexDocumentBusinessObjectDefinition in interface BusinessObjectDefinitionService

Parameters:

searchIndexUpdateDto - the SearchIndexUpdateDto object

updateSearchIndexDocumentBusinessObjectDefinitionImpl

protected void updateSearchIndexDocumentBusinessObjectDefinitionImpl(SearchIndexUpdateDto searchIndexUpdateDto)

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

Parameters:

searchIndexUpdateDto - the SearchIndexUpdateDto object