org.finra.herd.service

Interface UserNamespaceAuthorizationService

All Known Implementing Classes:

UserNamespaceAuthorizationServiceImpl

public interface UserNamespaceAuthorizationService

The business object definition service.

Method Summary

Modifier and Type	Method and Description
UserNamespaceAuthorization	createUserNamespaceAuthorization(UserNamespaceAuthorizationCreateRequest request) Creates a new user namespace authorization.
UserNamespaceAuthorization	deleteUserNamespaceAuthorization(UserNamespaceAuthorizationKey key) Deletes an existing user namespace authorization by key.
UserNamespaceAuthorization	getUserNamespaceAuthorization(UserNamespaceAuthorizationKey key) Gets an existing user namespace authorization by key.
UserNamespaceAuthorizations	getUserNamespaceAuthorizationsByNamespace(String namespace) Gets a list of user namespace authorizations for the specified namespace.
UserNamespaceAuthorizations	getUserNamespaceAuthorizationsByUserId(String userId) Gets a list of user namespace authorizations for the specified user.
UserNamespaceAuthorization	updateUserNamespaceAuthorization(UserNamespaceAuthorizationKey key, UserNamespaceAuthorizationUpdateRequest request) Updates an existing user namespace authorization by key.

Method Detail

createUserNamespaceAuthorization

UserNamespaceAuthorization createUserNamespaceAuthorization(UserNamespaceAuthorizationCreateRequest request)

Creates a new user namespace authorization.

Parameters:

request - the information needed to create the user namespace authorization

Returns:

the created user namespace authorization

updateUserNamespaceAuthorization

UserNamespaceAuthorization updateUserNamespaceAuthorization(UserNamespaceAuthorizationKey key,
                                                            UserNamespaceAuthorizationUpdateRequest request)

Updates an existing user namespace authorization by key.

Parameters:

key - the user namespace authorization key

request - the information needed to update the user namespace authorization

Returns:

the updated user namespace authorization

getUserNamespaceAuthorization

UserNamespaceAuthorization getUserNamespaceAuthorization(UserNamespaceAuthorizationKey key)

Gets an existing user namespace authorization by key.

Parameters:

key - the user namespace authorization key

Returns:

the retrieved user namespace authorization

deleteUserNamespaceAuthorization

UserNamespaceAuthorization deleteUserNamespaceAuthorization(UserNamespaceAuthorizationKey key)

Deletes an existing user namespace authorization by key.

Parameters:

key - the user namespace authorization key

Returns:

the deleted user namespace authorization

getUserNamespaceAuthorizationsByUserId

UserNamespaceAuthorizations getUserNamespaceAuthorizationsByUserId(String userId)

Gets a list of user namespace authorizations for the specified user.

Parameters:

userId - the user id

Returns:

the list of user namespace authorizations

getUserNamespaceAuthorizationsByNamespace

UserNamespaceAuthorizations getUserNamespaceAuthorizationsByNamespace(String namespace)

Gets a list of user namespace authorizations for the specified namespace.

Parameters:

namespace - the namespace

Returns:

the list of user namespace authorizations