org.finra.herd.service

Interface BusinessObjectDataAttributeService

All Known Implementing Classes:

BusinessObjectDataAttributeServiceImpl

public interface BusinessObjectDataAttributeService

The business object data attribute service.

Method Summary

Modifier and Type	Method and Description
BusinessObjectDataAttribute	createBusinessObjectDataAttribute(BusinessObjectDataAttributeCreateRequest businessObjectDataAttributeCreateRequest) Creates a new business object data attribute.
BusinessObjectDataAttribute	deleteBusinessObjectDataAttribute(BusinessObjectDataAttributeKey businessObjectDataAttributeKey) Deletes an existing business object data attribute by key.
BusinessObjectDataAttribute	getBusinessObjectDataAttribute(BusinessObjectDataAttributeKey businessObjectDataAttributeKey) Gets an existing business object data attribute by key.
BusinessObjectDataAttributeKeys	getBusinessObjectDataAttributes(BusinessObjectDataKey businessObjectDataKey) Gets a list of keys for all existing business object data attributes.
BusinessObjectDataAttribute	updateBusinessObjectDataAttribute(BusinessObjectDataAttributeKey businessObjectDataAttributeKey, BusinessObjectDataAttributeUpdateRequest businessObjectDataAttributeUpdateRequest) Updates an existing business object data attribute by key.

Method Detail

createBusinessObjectDataAttribute

BusinessObjectDataAttribute createBusinessObjectDataAttribute(BusinessObjectDataAttributeCreateRequest businessObjectDataAttributeCreateRequest)

Creates a new business object data attribute.

Parameters:

businessObjectDataAttributeCreateRequest - the information needed to create a business object data attribute

Returns:

the newly created business object data attribute

getBusinessObjectDataAttribute

BusinessObjectDataAttribute getBusinessObjectDataAttribute(BusinessObjectDataAttributeKey businessObjectDataAttributeKey)

Gets an existing business object data attribute by key.

Parameters:

businessObjectDataAttributeKey - the business object data attribute key

Returns:

the business object data attribute information

updateBusinessObjectDataAttribute

BusinessObjectDataAttribute updateBusinessObjectDataAttribute(BusinessObjectDataAttributeKey businessObjectDataAttributeKey,
                                                              BusinessObjectDataAttributeUpdateRequest businessObjectDataAttributeUpdateRequest)

Updates an existing business object data attribute by key.

Parameters:

businessObjectDataAttributeKey - the business object data attribute key

businessObjectDataAttributeUpdateRequest - the information needed to update a business object data attribute

Returns:

the business object data attribute information

deleteBusinessObjectDataAttribute

BusinessObjectDataAttribute deleteBusinessObjectDataAttribute(BusinessObjectDataAttributeKey businessObjectDataAttributeKey)

Deletes an existing business object data attribute by key.

Parameters:

businessObjectDataAttributeKey - the business object data attribute key

Returns:

the business object data attribute information for the attribute that got deleted

getBusinessObjectDataAttributes

BusinessObjectDataAttributeKeys getBusinessObjectDataAttributes(BusinessObjectDataKey businessObjectDataKey)

Gets a list of keys for all existing business object data attributes.

Parameters:

businessObjectDataKey - the business object data key

Returns:

the list of business object data attribute keys