org.finra.herd.service

Interface SecurityRoleFunctionService

All Known Implementing Classes:

SecurityRoleFunctionServiceImpl

public interface SecurityRoleFunctionService

The security role to function mapping service.

Method Summary

Modifier and Type	Method and Description
SecurityRoleFunction	createSecurityRoleFunction(SecurityRoleFunctionCreateRequest securityRoleFunctionCreateRequest) Creates a new security role to function mapping.
SecurityRoleFunction	deleteSecurityRoleFunction(SecurityRoleFunctionKey securityRoleFunctionKey) Deletes an existing security role to function mapping by its key.
SecurityRoleFunction	getSecurityRoleFunction(SecurityRoleFunctionKey securityRoleFunctionKey) Retrieves an existing security role to function mapping by its key.
SecurityRoleFunctionKeys	getSecurityRoleFunctions() Retrieves a list of security role to function mapping keys for all security role to function mappings registered in the system.
SecurityRoleFunctionKeys	getSecurityRoleFunctionsBySecurityFunction(SecurityFunctionKey securityFunctionKey) Retrieves a list of security role to function mapping keys for the specified security function.
SecurityRoleFunctionKeys	getSecurityRoleFunctionsBySecurityRole(SecurityRoleKey securityRoleKey) Retrieves a list of security role to function mapping keys for the specified security role.

Method Detail

createSecurityRoleFunction

SecurityRoleFunction createSecurityRoleFunction(SecurityRoleFunctionCreateRequest securityRoleFunctionCreateRequest)

Creates a new security role to function mapping.

Parameters:

securityRoleFunctionCreateRequest - the information needed to create a security role to function mapping

Returns:

the created security role to function mapping

deleteSecurityRoleFunction

SecurityRoleFunction deleteSecurityRoleFunction(SecurityRoleFunctionKey securityRoleFunctionKey)

Deletes an existing security role to function mapping by its key.

Parameters:

securityRoleFunctionKey - the security role to function mapping key

Returns:

the deleted security role to function mapping

getSecurityRoleFunction

SecurityRoleFunction getSecurityRoleFunction(SecurityRoleFunctionKey securityRoleFunctionKey)

Retrieves an existing security role to function mapping by its key.

Parameters:

securityRoleFunctionKey - the security role to function mapping key

Returns:

the retrieved security role to function mapping

getSecurityRoleFunctions

SecurityRoleFunctionKeys getSecurityRoleFunctions()

Retrieves a list of security role to function mapping keys for all security role to function mappings registered in the system.

Returns:

the list of security role to function mapping keys

getSecurityRoleFunctionsBySecurityFunction

SecurityRoleFunctionKeys getSecurityRoleFunctionsBySecurityFunction(SecurityFunctionKey securityFunctionKey)

Retrieves a list of security role to function mapping keys for the specified security function.

Parameters:

securityFunctionKey - the security function key

Returns:

the list of security role to function mapping keys

getSecurityRoleFunctionsBySecurityRole

SecurityRoleFunctionKeys getSecurityRoleFunctionsBySecurityRole(SecurityRoleKey securityRoleKey)

Retrieves a list of security role to function mapping keys for the specified security role.

Parameters:

securityRoleKey - the security role key

Returns:

the list of security role to function mapping keys