org.finra.herd.sdk.api

Class BusinessObjectDefinitionColumnApi

java.lang.Object

org.finra.herd.sdk.api.BusinessObjectDefinitionColumnApi

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

Constructor Summary

Constructors

Constructor and Description
BusinessObjectDefinitionColumnApi()
BusinessObjectDefinitionColumnApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
BusinessObjectDefinitionColumn	businessObjectDefinitionColumnCreateBusinessObjectDefinitionColumn(BusinessObjectDefinitionColumnCreateRequest businessObjectDefinitionColumnCreateRequest) createBusinessObjectDefinitionColumn Creates a new business object definition column.
BusinessObjectDefinitionColumn	businessObjectDefinitionColumnDeleteBusinessObjectDefinitionColumn(String namespace, String businessObjectDefinitionName, String businessObjectDefinitionColumnName) deleteBusinessObjectDefinitionColumn Deletes an existing column for the business object definition.
BusinessObjectDefinitionColumn	businessObjectDefinitionColumnGetBusinessObjectDefinitionColumn(String namespace, String businessObjectDefinitionName, String businessObjectDefinitionColumnName) getBusinessObjectDefinitionColumn Gets an existing column for the business object definition.
BusinessObjectDefinitionColumnKeys	businessObjectDefinitionColumnGetBusinessObjectDefinitionColumns(String namespace, String businessObjectDefinitionName) getBusinessObjectDefinitionColumns Gets a list of keys for all existing business object definition columns for a specific business object definition.
BusinessObjectDefinitionColumnSearchResponse	businessObjectDefinitionColumnSearchBusinessObjectDefinitionColumns(BusinessObjectDefinitionColumnSearchRequest businessObjectDefinitionColumnSearchRequest, String fields) searchBusinessObjectDefinitionColumns Retrieve a list of business object definition columns meeting the search criteria filters and fields request.
BusinessObjectDefinitionColumn	businessObjectDefinitionColumnUpdateBusinessObjectDefinitionColumn(String namespace, String businessObjectDefinitionName, String businessObjectDefinitionColumnName, BusinessObjectDefinitionColumnUpdateRequest businessObjectDefinitionColumnUpdateRequest) updateBusinessObjectDefinitionColumn Updates an existing column for the business object definition.
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

BusinessObjectDefinitionColumnApi

public BusinessObjectDefinitionColumnApi()

BusinessObjectDefinitionColumnApi

public BusinessObjectDefinitionColumnApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

businessObjectDefinitionColumnCreateBusinessObjectDefinitionColumn

public BusinessObjectDefinitionColumn businessObjectDefinitionColumnCreateBusinessObjectDefinitionColumn(BusinessObjectDefinitionColumnCreateRequest businessObjectDefinitionColumnCreateRequest)
                                                                                                  throws ApiException

createBusinessObjectDefinitionColumn Creates a new business object definition column.

Parameters:

businessObjectDefinitionColumnCreateRequest - the information needed to create a business object definition column

Returns:

BusinessObjectDefinitionColumn

Throws:

ApiException

businessObjectDefinitionColumnGetBusinessObjectDefinitionColumns

public BusinessObjectDefinitionColumnKeys businessObjectDefinitionColumnGetBusinessObjectDefinitionColumns(String namespace,
                                                                                                           String businessObjectDefinitionName)
                                                                                                    throws ApiException

getBusinessObjectDefinitionColumns Gets a list of keys for all existing business object definition columns for a specific business object definition.

Parameters:

namespace - the namespace of the business object definition

businessObjectDefinitionName - the name of the business object definition

Returns:

BusinessObjectDefinitionColumnKeys

Throws:

ApiException

businessObjectDefinitionColumnGetBusinessObjectDefinitionColumn

public BusinessObjectDefinitionColumn businessObjectDefinitionColumnGetBusinessObjectDefinitionColumn(String namespace,
                                                                                                      String businessObjectDefinitionName,
                                                                                                      String businessObjectDefinitionColumnName)
                                                                                               throws ApiException

getBusinessObjectDefinitionColumn Gets an existing column for the business object definition.

Parameters:

namespace - the namespace of the business object definition

businessObjectDefinitionName - the name of the business object definition

businessObjectDefinitionColumnName - the name of the business object definition column

Returns:

BusinessObjectDefinitionColumn

Throws:

ApiException

businessObjectDefinitionColumnUpdateBusinessObjectDefinitionColumn

public BusinessObjectDefinitionColumn businessObjectDefinitionColumnUpdateBusinessObjectDefinitionColumn(String namespace,
                                                                                                         String businessObjectDefinitionName,
                                                                                                         String businessObjectDefinitionColumnName,
                                                                                                         BusinessObjectDefinitionColumnUpdateRequest businessObjectDefinitionColumnUpdateRequest)
                                                                                                  throws ApiException

updateBusinessObjectDefinitionColumn Updates an existing column for the business object definition.

Parameters:

namespace - the namespace of the business object definition

businessObjectDefinitionName - the name of the business object definition

businessObjectDefinitionColumnName - the name of the business object definition column

businessObjectDefinitionColumnUpdateRequest - the request information needed to update the business object definition column

Returns:

BusinessObjectDefinitionColumn

Throws:

ApiException

businessObjectDefinitionColumnDeleteBusinessObjectDefinitionColumn

public BusinessObjectDefinitionColumn businessObjectDefinitionColumnDeleteBusinessObjectDefinitionColumn(String namespace,
                                                                                                         String businessObjectDefinitionName,
                                                                                                         String businessObjectDefinitionColumnName)
                                                                                                  throws ApiException

deleteBusinessObjectDefinitionColumn Deletes an existing column for the business object definition.

Parameters:

namespace - the namespace of the business object definition

businessObjectDefinitionName - the name of the business object definition

businessObjectDefinitionColumnName - the name of the business object definition column

Returns:

BusinessObjectDefinitionColumn

Throws:

ApiException

businessObjectDefinitionColumnSearchBusinessObjectDefinitionColumns

public BusinessObjectDefinitionColumnSearchResponse businessObjectDefinitionColumnSearchBusinessObjectDefinitionColumns(BusinessObjectDefinitionColumnSearchRequest businessObjectDefinitionColumnSearchRequest,
                                                                                                                        String fields)
                                                                                                                 throws ApiException

searchBusinessObjectDefinitionColumns Retrieve a list of business object definition columns meeting the search criteria filters and fields request.

Parameters:

businessObjectDefinitionColumnSearchRequest - the search criteria needed to find a list of business object definition columns

fields - the field options for the business object definition columns search response. The valid field options are: description, schemaColumnName

Returns:

BusinessObjectDefinitionColumnSearchResponse

Throws:

ApiException