Package ru.cg.webbpm.studio.subsystems.bpmn.role.api.registry

Interface RolesManager

All Known Implementing Classes:

RolesManagerImpl

public interface RolesManager

Author:

Tim Urmancheev

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	RolesManager.RolesChangedCallback

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NON_UNIQUE_ROLE_NAME_EXCEPTION

Method Summary

Modifier and Type	Method	Description
void	addChangeListener(RolesManager.RolesChangedCallback callback)
void	checkThatRolesFileExists()
void	createRole(Role role)	Creates new role.
List<Role>	getAllRoles()
List<String>	getResourcesUsingRole(String role)
Optional<Role>	getRole(String role)
Set<String>	getUsedRoles(WebbpmProcess process)
Set<String>	getUsedRoles(XmlComponent component)
Set<String>	getUsedRoles(XmlPage page)
void	reloadRoles()
void	removeChangeListener(RolesManager.RolesChangedCallback callback)
void	removeRole(Role role)
void	updateRole(String prevName, Role role)	Updates existing role.

Field Details

NON_UNIQUE_ROLE_NAME_EXCEPTION

static final String NON_UNIQUE_ROLE_NAME_EXCEPTION

See Also:

• Constant Field Values

Method Details

getAllRoles

List<Role> getAllRoles()

createRole

void createRole(Role role)
         throws ProjectOperationException

Creates new role.

Parameters:

role - - role needed to create

Throws:

ProjectOperationException - if any exception happens. Will be with code NON_UNIQUE_ROLE_NAME_EXCEPTION code if role with same name already exists.

updateRole

void updateRole(String prevName,
 Role role)
         throws ProjectOperationException

Updates existing role.

Parameters:

prevName - - name of changed role before update

role - - changed role

Throws:

ProjectOperationException - if any exception happens. Will be with code NON_UNIQUE_ROLE_NAME_EXCEPTION code if role name has been modified and role with new name already exists.

removeRole

void removeRole(Role role)
         throws ProjectOperationException

Throws:

ProjectOperationException

reloadRoles

void reloadRoles()

getRole

Optional<Role> getRole(String role)
                throws ProjectOperationException

Throws:

ProjectOperationException

checkThatRolesFileExists

void checkThatRolesFileExists()
                       throws ProjectOperationException

Throws:

ProjectOperationException

addChangeListener

void addChangeListener(RolesManager.RolesChangedCallback callback)

removeChangeListener

void removeChangeListener(RolesManager.RolesChangedCallback callback)

getUsedRoles

Set<String> getUsedRoles(WebbpmProcess process)

Parameters:

process - where the roles will look

Returns:

a set of roles used for the process

getUsedRoles

Set<String> getUsedRoles(XmlPage page)

Parameters:

page - where the roles will look

Returns:

a set of roles used for the page

getUsedRoles

Set<String> getUsedRoles(XmlComponent component)

Parameters:

component - where the roles will look

Returns:

a set of roles used for the component

getResourcesUsingRole

List<String> getResourcesUsingRole(String role)

Parameters:

role - which will look in resources

Returns:

a list of resources using the role