org.finra.herd.service.helper

Class BusinessObjectDefinitionHelper

java.lang.Object

org.finra.herd.service.helper.BusinessObjectDefinitionHelper

@Component
public class BusinessObjectDefinitionHelper
extends Object

A helper class for BusinessObjectDefinition related code.

Constructor Summary

Constructors

Constructor and Description
BusinessObjectDefinitionHelper()

Method Summary

Modifier and Type	Method and Description
String	businessObjectDefinitionKeyToString(BusinessObjectDefinitionKey businessObjectDefinitionKey) Returns a string representation of the business object definition key.
void	executeFunctionForBusinessObjectDefinitionEntities(String indexName, String documentType, List<BusinessObjectDefinitionEntity> businessObjectDefinitionEntities, QuadConsumer<String,String,String,String> function) Executes a function for business object definition entities.
BusinessObjectDefinitionKey	getBusinessObjectDefinitionKey(BusinessObjectDefinitionColumnKey businessObjectDefinitionColumnKey) Gets a business object definition key from the specified business object definition column key.
void	validateBusinessObjectDefinitionKey(BusinessObjectDefinitionKey key) Validates the business object definition key.

Methods inherited from class java.lang.Object

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

Constructor Detail

BusinessObjectDefinitionHelper

public BusinessObjectDefinitionHelper()

Method Detail

businessObjectDefinitionKeyToString

public String businessObjectDefinitionKeyToString(BusinessObjectDefinitionKey businessObjectDefinitionKey)

Returns a string representation of the business object definition key.

Parameters:

businessObjectDefinitionKey - the business object definition key

Returns:

the string representation of the business object definition key

executeFunctionForBusinessObjectDefinitionEntities

public void executeFunctionForBusinessObjectDefinitionEntities(String indexName,
                                                               String documentType,
                                                               List<BusinessObjectDefinitionEntity> businessObjectDefinitionEntities,
                                                               QuadConsumer<String,String,String,String> function)

Executes a function for business object definition entities.

Parameters:

indexName - the name of the index

documentType - the document type

businessObjectDefinitionEntities - the list of business object definitions entities

function - the function to apply to all business object definitions

getBusinessObjectDefinitionKey

public BusinessObjectDefinitionKey getBusinessObjectDefinitionKey(BusinessObjectDefinitionColumnKey businessObjectDefinitionColumnKey)

Gets a business object definition key from the specified business object definition column key.

Parameters:

businessObjectDefinitionColumnKey - the business object definition column key

Returns:

the business object definition key

validateBusinessObjectDefinitionKey

public void validateBusinessObjectDefinitionKey(BusinessObjectDefinitionKey key)
                                         throws IllegalArgumentException

Validates the business object definition key. This method also trims the key parameters.

Parameters:

key - the business object definition key

Throws:

IllegalArgumentException - if any validation errors were found