org.finra.herd.sdk.api

Class BusinessObjectDefinitionApi

java.lang.Object

org.finra.herd.sdk.api.BusinessObjectDefinitionApi

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-02-24T15:10:39.441-05:00")
public class BusinessObjectDefinitionApi
extends Object

Constructor Summary

Constructors

Constructor and Description
BusinessObjectDefinitionApi()
BusinessObjectDefinitionApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
BusinessObjectDefinition	businessObjectDefinitionCreateBusinessObjectDefinition(BusinessObjectDefinitionCreateRequest businessObjectDefinitionCreateRequest) createBusinessObjectDefinition Creates a new business object definition.
BusinessObjectDefinition	businessObjectDefinitionDeleteBusinessObjectDefinition(String namespace, String businessObjectDefinitionName) deleteBusinessObjectDefinition Deletes an existing business object definition by key.
BusinessObjectDefinition	businessObjectDefinitionGetBusinessObjectDefinition(String namespace, String businessObjectDefinitionName) getBusinessObjectDefinition Gets an existing business object definition by key.
BusinessObjectDefinitionKeys	businessObjectDefinitionGetBusinessObjectDefinitions(String namespace) getBusinessObjectDefinitions Gets the list of business object definitions that are defined in the system.
BusinessObjectDefinitionKeys	businessObjectDefinitionGetBusinessObjectDefinitions1() getBusinessObjectDefinitions Gets the list of business object definitions that are defined in the system.
BusinessObjectDefinitionIndexSearchResponse	businessObjectDefinitionIndexSearchBusinessObjectDefinitions(BusinessObjectDefinitionIndexSearchRequest businessObjectDefinitionIndexSearchRequest, String fields) indexSearchBusinessObjectDefinitions Searches across all business object definitions that are in search index per specified search filters and keys
BusinessObjectDefinitionSearchResponse	businessObjectDefinitionSearchBusinessObjectDefinitions(BusinessObjectDefinitionSearchRequest businessObjectDefinitionSearchRequest, String fields) searchBusinessObjectDefinitions Searches across all business object definitions that are defined in the system per specified search filters and keys
BusinessObjectDefinition	businessObjectDefinitionUpdateBusinessObjectDefinition(String namespace, String businessObjectDefinitionName, BusinessObjectDefinitionUpdateRequest businessObjectDefinitionUpdateRequest) updateBusinessObjectDefinition Updates an existing business object definition by key.
BusinessObjectDefinition	businessObjectDefinitionUpdateBusinessObjectDefinitionDescriptiveInformation(String namespace, String businessObjectDefinitionName, BusinessObjectDefinitionDescriptiveInformationUpdateRequest businessObjectDefinitionDescriptiveInformationUpdateRequest) updateBusinessObjectDefinitionDescriptiveInformation Updates an existing business object definition descriptive information by key.
BusinessObjectDefinitionValidateResponse	businessObjectDefinitionValidateIndexBusinessObjectDefinitions() validateIndexBusinessObjectDefinitions Validate all business object definitions in the index
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

BusinessObjectDefinitionApi

public BusinessObjectDefinitionApi()

BusinessObjectDefinitionApi

public BusinessObjectDefinitionApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

businessObjectDefinitionUpdateBusinessObjectDefinitionDescriptiveInformation

public BusinessObjectDefinition businessObjectDefinitionUpdateBusinessObjectDefinitionDescriptiveInformation(String namespace,
                                                                                                             String businessObjectDefinitionName,
                                                                                                             BusinessObjectDefinitionDescriptiveInformationUpdateRequest businessObjectDefinitionDescriptiveInformationUpdateRequest)
                                                                                                      throws ApiException

updateBusinessObjectDefinitionDescriptiveInformation Updates an existing business object definition descriptive information by key. <p>Requires no Namespace level security</p>

Parameters:

namespace - the namespace code

businessObjectDefinitionName - the name of the business object definition to update

businessObjectDefinitionDescriptiveInformationUpdateRequest - the information needed to update the business object definition

Returns:

BusinessObjectDefinition

Throws:

ApiException

businessObjectDefinitionGetBusinessObjectDefinitions1

public BusinessObjectDefinitionKeys businessObjectDefinitionGetBusinessObjectDefinitions1()
                                                                                   throws ApiException

getBusinessObjectDefinitions Gets the list of business object definitions that are defined in the system.

Returns:

BusinessObjectDefinitionKeys

Throws:

ApiException

businessObjectDefinitionCreateBusinessObjectDefinition

public BusinessObjectDefinition businessObjectDefinitionCreateBusinessObjectDefinition(BusinessObjectDefinitionCreateRequest businessObjectDefinitionCreateRequest)
                                                                                throws ApiException

createBusinessObjectDefinition Creates a new business object definition. <p>Requires WRITE permission on namespace</p>

Parameters:

businessObjectDefinitionCreateRequest - the information needed to create the business object definition.

Returns:

BusinessObjectDefinition

Throws:

ApiException

businessObjectDefinitionIndexSearchBusinessObjectDefinitions

public BusinessObjectDefinitionIndexSearchResponse businessObjectDefinitionIndexSearchBusinessObjectDefinitions(BusinessObjectDefinitionIndexSearchRequest businessObjectDefinitionIndexSearchRequest,
                                                                                                                String fields)
                                                                                                         throws ApiException

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

Parameters:

businessObjectDefinitionIndexSearchRequest - the information needed to search across the business object definitions

fields - A comma-separated list of fields to be retrieved with each business object definition entity. Valid options: dataProviderName, shortDescription, displayName

Returns:

BusinessObjectDefinitionIndexSearchResponse

Throws:

ApiException

businessObjectDefinitionGetBusinessObjectDefinitions

public BusinessObjectDefinitionKeys businessObjectDefinitionGetBusinessObjectDefinitions(String namespace)
                                                                                  throws ApiException

getBusinessObjectDefinitions Gets the list of business object definitions that are defined in the system.

Parameters:

namespace - the namespace code

Returns:

BusinessObjectDefinitionKeys

Throws:

ApiException

businessObjectDefinitionGetBusinessObjectDefinition

public BusinessObjectDefinition businessObjectDefinitionGetBusinessObjectDefinition(String namespace,
                                                                                    String businessObjectDefinitionName)
                                                                             throws ApiException

getBusinessObjectDefinition Gets an existing business object definition by key.

Parameters:

namespace - the namespace code

businessObjectDefinitionName - the business object definition name

Returns:

BusinessObjectDefinition

Throws:

ApiException

businessObjectDefinitionUpdateBusinessObjectDefinition

public BusinessObjectDefinition businessObjectDefinitionUpdateBusinessObjectDefinition(String namespace,
                                                                                       String businessObjectDefinitionName,
                                                                                       BusinessObjectDefinitionUpdateRequest businessObjectDefinitionUpdateRequest)
                                                                                throws ApiException

updateBusinessObjectDefinition Updates an existing business object definition by key. <p>Requires WRITE permission on namespace</p>

Parameters:

namespace - the namespace code

businessObjectDefinitionName - the name of the business object definition to update

businessObjectDefinitionUpdateRequest - the information needed to update the business object definition

Returns:

BusinessObjectDefinition

Throws:

ApiException

businessObjectDefinitionDeleteBusinessObjectDefinition

public BusinessObjectDefinition businessObjectDefinitionDeleteBusinessObjectDefinition(String namespace,
                                                                                       String businessObjectDefinitionName)
                                                                                throws ApiException

deleteBusinessObjectDefinition Deletes an existing business object definition by key. <p>Requires WRITE permission on namespace</p>

Parameters:

namespace - the namespace code

businessObjectDefinitionName - the business object definition name

Returns:

BusinessObjectDefinition

Throws:

ApiException

businessObjectDefinitionSearchBusinessObjectDefinitions

public BusinessObjectDefinitionSearchResponse businessObjectDefinitionSearchBusinessObjectDefinitions(BusinessObjectDefinitionSearchRequest businessObjectDefinitionSearchRequest,
                                                                                                      String fields)
                                                                                               throws ApiException

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

Parameters:

businessObjectDefinitionSearchRequest - the information needed to search across the business object definitions

fields - A comma-separated list of fields to be retrieved with each business object definition entity. Valid options: dataProviderName, shortDescription, displayName

Returns:

BusinessObjectDefinitionSearchResponse

Throws:

ApiException

businessObjectDefinitionValidateIndexBusinessObjectDefinitions

public BusinessObjectDefinitionValidateResponse businessObjectDefinitionValidateIndexBusinessObjectDefinitions()
                                                                                                        throws ApiException

validateIndexBusinessObjectDefinitions Validate all business object definitions in the index

Returns:

BusinessObjectDefinitionValidateResponse

Throws:

ApiException