org.finra.herd.sdk.api

Class CustomDDLApi

java.lang.Object

org.finra.herd.sdk.api.CustomDDLApi

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

Constructor Summary

Constructors

Constructor and Description
CustomDDLApi()
CustomDDLApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
CustomDdl	customDDLCreateCustomDdl(CustomDdlCreateRequest customDdlCreateRequest) createCustomDdl Creates a new custom DDL.
CustomDdl	customDDLDeleteCustomDdl(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String customDdlName) deleteCustomDdl Deletes an existing custom DDL.
CustomDdl	customDDLGetCustomDdl(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String customDdlName) getCustomDdl Gets an existing custom DDL.
CustomDdlKeys	customDDLGetCustomDdls(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion) getCustomDdls Gets a list of keys for all existing custom DDLs for a specific business object format.
CustomDdl	customDDLUpdateCustomDdl(String namespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType, Integer businessObjectFormatVersion, String customDdlName, CustomDdlUpdateRequest customDdlUpdateRequest) updateCustomDdl Updates an existing custom DDL.
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

CustomDDLApi

public CustomDDLApi()

CustomDDLApi

public CustomDDLApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

customDDLCreateCustomDdl

public CustomDdl customDDLCreateCustomDdl(CustomDdlCreateRequest customDdlCreateRequest)
                                   throws ApiException

createCustomDdl Creates a new custom DDL. <p>Requires WRITE permission on namespace</p>

Parameters:

customDdlCreateRequest - the information needed to create a custom DDL

Returns:

CustomDdl

Throws:

ApiException

customDDLGetCustomDdls

public CustomDdlKeys customDDLGetCustomDdls(String namespace,
                                            String businessObjectDefinitionName,
                                            String businessObjectFormatUsage,
                                            String businessObjectFormatFileType,
                                            Integer businessObjectFormatVersion)
                                     throws ApiException

getCustomDdls Gets a list of keys for all existing custom DDLs for a specific business object format. <p>Requires READ permission on namespace</p>

Parameters:

namespace - the namespace

businessObjectDefinitionName - the business object definition name

businessObjectFormatUsage - the business object format usage

businessObjectFormatFileType - the business object format file type

businessObjectFormatVersion - the business object format version

Returns:

CustomDdlKeys

Throws:

ApiException

customDDLGetCustomDdl

public CustomDdl customDDLGetCustomDdl(String namespace,
                                       String businessObjectDefinitionName,
                                       String businessObjectFormatUsage,
                                       String businessObjectFormatFileType,
                                       Integer businessObjectFormatVersion,
                                       String customDdlName)
                                throws ApiException

getCustomDdl Gets an existing custom DDL. <p>Requires READ permission on namespace</p>

Parameters:

namespace - the namespace

businessObjectDefinitionName - the business object definition name

businessObjectFormatUsage - the business object format usage

businessObjectFormatFileType - the business object format file type

businessObjectFormatVersion - the business object format version

customDdlName - the custom DDL name

Returns:

CustomDdl

Throws:

ApiException

customDDLUpdateCustomDdl

public CustomDdl customDDLUpdateCustomDdl(String namespace,
                                          String businessObjectDefinitionName,
                                          String businessObjectFormatUsage,
                                          String businessObjectFormatFileType,
                                          Integer businessObjectFormatVersion,
                                          String customDdlName,
                                          CustomDdlUpdateRequest customDdlUpdateRequest)
                                   throws ApiException

updateCustomDdl Updates an existing custom DDL. <p>Requires WRITE permission on namespace</p>

Parameters:

namespace - the namespace

businessObjectDefinitionName - the business object definition name

businessObjectFormatUsage - the business object format usage

businessObjectFormatFileType - the business object format file type

businessObjectFormatVersion - the business object format version

customDdlName - the custom DDL name

customDdlUpdateRequest - the request information needed to update the custom DDL

Returns:

CustomDdl

Throws:

ApiException

customDDLDeleteCustomDdl

public CustomDdl customDDLDeleteCustomDdl(String namespace,
                                          String businessObjectDefinitionName,
                                          String businessObjectFormatUsage,
                                          String businessObjectFormatFileType,
                                          Integer businessObjectFormatVersion,
                                          String customDdlName)
                                   throws ApiException

deleteCustomDdl Deletes an existing custom DDL. <p>Requires WRITE permission on namespace</p>

Parameters:

namespace - the namespace

businessObjectDefinitionName - the business object definition name

businessObjectFormatUsage - the business object format usage

businessObjectFormatFileType - the business object format file type

businessObjectFormatVersion - the business object format version

customDdlName - the custom DDL name

Returns:

CustomDdl

Throws:

ApiException