org.finra.herd.service

Interface SecurityRoleService

All Known Implementing Classes:

SecurityRoleServiceImpl

public interface SecurityRoleService

The security Role service.

Method Summary

Modifier and Type	Method and Description
SecurityRole	createSecurityRole(SecurityRoleCreateRequest securityRoleCreateRequest) Creates a new security role
SecurityRole	deleteSecurityRole(SecurityRoleKey securityRoleName) Deletes a security role
SecurityRole	getSecurityRole(SecurityRoleKey securityRoleKey) Gets a security role
SecurityRoleKeys	getSecurityRoles() Gets a list of security role keys for all security roles defined in the system
SecurityRole	updateSecurityRole(SecurityRoleKey securityRoleKey, SecurityRoleUpdateRequest securityRoleUpdateRequest) Updates a security role

Method Detail

createSecurityRole

SecurityRole createSecurityRole(SecurityRoleCreateRequest securityRoleCreateRequest)

Creates a new security role

Parameters:

securityRoleCreateRequest - the security role create request

Returns:

the created security role

getSecurityRole

SecurityRole getSecurityRole(SecurityRoleKey securityRoleKey)

Gets a security role

Parameters:

securityRoleKey - the security role key

Returns:

the retrieved security role

deleteSecurityRole

SecurityRole deleteSecurityRole(SecurityRoleKey securityRoleName)

Deletes a security role

Parameters:

securityRoleName - the security role name

Returns:

the security role that was deleted

updateSecurityRole

SecurityRole updateSecurityRole(SecurityRoleKey securityRoleKey,
                                SecurityRoleUpdateRequest securityRoleUpdateRequest)

Updates a security role

Parameters:

securityRoleKey - the security role key

securityRoleUpdateRequest - the security role update request

Returns:

the security role that was updated

getSecurityRoles

SecurityRoleKeys getSecurityRoles()

Gets a list of security role keys for all security roles defined in the system

Returns:

the security role keys