org.finra.herd.sdk.api

Class BusinessObjectDataNotificationRegistrationApi

java.lang.Object

org.finra.herd.sdk.api.BusinessObjectDataNotificationRegistrationApi

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

Constructor Summary

Constructors

Constructor and Description
BusinessObjectDataNotificationRegistrationApi()
BusinessObjectDataNotificationRegistrationApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
BusinessObjectDataNotificationRegistration	businessObjectDataNotificationRegistrationCreateBusinessObjectDataNotificationRegistration(BusinessObjectDataNotificationRegistrationCreateRequest businessObjectDataNotificationRegistrationCreateRequest) createBusinessObjectDataNotificationRegistration Creates a new business object data notification.
BusinessObjectDataNotificationRegistration	businessObjectDataNotificationRegistrationDeleteBusinessObjectDataNotification(String namespace, String notificationName) deleteBusinessObjectDataNotification Deletes an existing business object data notification by key.
BusinessObjectDataNotificationRegistration	businessObjectDataNotificationRegistrationGetBusinessObjectDataNotificationRegistration(String namespace, String notificationName) getBusinessObjectDataNotificationRegistration Gets an existing business object data notification by key.
BusinessObjectDataNotificationRegistrationKeys	businessObjectDataNotificationRegistrationGetBusinessObjectDataNotificationRegistrationsByNamespace(String namespace) getBusinessObjectDataNotificationRegistrationsByNamespace Gets a list of keys for all existing business object data notification registrations for the specified business object data notification registration namespace.
BusinessObjectDataNotificationRegistrationKeys	businessObjectDataNotificationRegistrationGetBusinessObjectDataNotificationRegistrationsByNotificationFilter(String businessObjectDefinitionNamespace, String businessObjectDefinitionName, String businessObjectFormatUsage, String businessObjectFormatFileType) getBusinessObjectDataNotificationRegistrationsByNotificationFilter <p> Gets a list of keys for all existing business object data notification registrations that match the specified business object data notification filter parameters.
BusinessObjectDataNotificationRegistration	businessObjectDataNotificationRegistrationUpdateBusinessObjectDataNotificationRegistration(String namespace, String notificationName, BusinessObjectDataNotificationRegistrationUpdateRequest businessObjectDataNotificationRegistrationUpdateRequest) updateBusinessObjectDataNotificationRegistration Updates an existing business object data notification by key.
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

BusinessObjectDataNotificationRegistrationApi

public BusinessObjectDataNotificationRegistrationApi()

BusinessObjectDataNotificationRegistrationApi

public BusinessObjectDataNotificationRegistrationApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

businessObjectDataNotificationRegistrationGetBusinessObjectDataNotificationRegistrationsByNotificationFilter

public BusinessObjectDataNotificationRegistrationKeys businessObjectDataNotificationRegistrationGetBusinessObjectDataNotificationRegistrationsByNotificationFilter(String businessObjectDefinitionNamespace,
                                                                                                                                                                   String businessObjectDefinitionName,
                                                                                                                                                                   String businessObjectFormatUsage,
                                                                                                                                                                   String businessObjectFormatFileType)
                                                                                                                                                            throws ApiException

getBusinessObjectDataNotificationRegistrationsByNotificationFilter <p> Gets a list of keys for all existing business object data notification registrations that match the specified business object data notification filter parameters. </p> <p> This endpoint requires both namespace and name of the business object definition. </p> <p>Requires READ permission on business object definition namespace</p>

Parameters:

businessObjectDefinitionNamespace - the namespace of the business object definition

businessObjectDefinitionName - the name of the business object definition

businessObjectFormatUsage - the usage of the business object format

businessObjectFormatFileType - the file type of the business object format

Returns:

BusinessObjectDataNotificationRegistrationKeys

Throws:

ApiException

businessObjectDataNotificationRegistrationCreateBusinessObjectDataNotificationRegistration

public BusinessObjectDataNotificationRegistration businessObjectDataNotificationRegistrationCreateBusinessObjectDataNotificationRegistration(BusinessObjectDataNotificationRegistrationCreateRequest businessObjectDataNotificationRegistrationCreateRequest)
                                                                                                                                      throws ApiException

createBusinessObjectDataNotificationRegistration Creates a new business object data notification. <p>Requires WRITE permission on namespace</p> <p>Requires READ permission on filter namespace</p> <p>Requires EXECUTE permission on ALL job action namespaces</p>

Parameters:

businessObjectDataNotificationRegistrationCreateRequest - the information needed to create the business object data notification

Returns:

BusinessObjectDataNotificationRegistration

Throws:

ApiException

businessObjectDataNotificationRegistrationGetBusinessObjectDataNotificationRegistrationsByNamespace

public BusinessObjectDataNotificationRegistrationKeys businessObjectDataNotificationRegistrationGetBusinessObjectDataNotificationRegistrationsByNamespace(String namespace)
                                                                                                                                                   throws ApiException

getBusinessObjectDataNotificationRegistrationsByNamespace Gets a list of keys for all existing business object data notification registrations for the specified business object data notification registration namespace.

Parameters:

namespace - the namespace of the business object data notification registration

Returns:

BusinessObjectDataNotificationRegistrationKeys

Throws:

ApiException

businessObjectDataNotificationRegistrationGetBusinessObjectDataNotificationRegistration

public BusinessObjectDataNotificationRegistration businessObjectDataNotificationRegistrationGetBusinessObjectDataNotificationRegistration(String namespace,
                                                                                                                                          String notificationName)
                                                                                                                                   throws ApiException

getBusinessObjectDataNotificationRegistration Gets an existing business object data notification by key. <p>Requires READ permission on namespace</p>

Parameters:

namespace - the namespace

notificationName - the business object data notification name

Returns:

BusinessObjectDataNotificationRegistration

Throws:

ApiException

businessObjectDataNotificationRegistrationUpdateBusinessObjectDataNotificationRegistration

public BusinessObjectDataNotificationRegistration businessObjectDataNotificationRegistrationUpdateBusinessObjectDataNotificationRegistration(String namespace,
                                                                                                                                             String notificationName,
                                                                                                                                             BusinessObjectDataNotificationRegistrationUpdateRequest businessObjectDataNotificationRegistrationUpdateRequest)
                                                                                                                                      throws ApiException

updateBusinessObjectDataNotificationRegistration Updates an existing business object data notification by key. <p>Requires WRITE permission on namespace</p> <p>Requires READ permission on filter namespace</p> <p>Requires EXECUTE permission on ALL job action namespaces</p>

Parameters:

namespace - the namespace

notificationName - the business object data notification name

businessObjectDataNotificationRegistrationUpdateRequest - the information needed to update the business object data notification

Returns:

BusinessObjectDataNotificationRegistration

Throws:

ApiException

businessObjectDataNotificationRegistrationDeleteBusinessObjectDataNotification

public BusinessObjectDataNotificationRegistration businessObjectDataNotificationRegistrationDeleteBusinessObjectDataNotification(String namespace,
                                                                                                                                 String notificationName)
                                                                                                                          throws ApiException

deleteBusinessObjectDataNotification Deletes an existing business object data notification by key. <p>Requires WRITE permission on namespace</p>

Parameters:

namespace - the namespace

notificationName - the business object data notification name

Returns:

BusinessObjectDataNotificationRegistration

Throws:

ApiException