Interface IRoleManager

All Superinterfaces:

IDisposable, IEntity

public interface IRoleManager
extends IEntity

Manages the roles.

Method Summary

Modifier and Type	Method	Description
void	deleteRole(String roleName)	Deletes a role.
int	duplicateRole(String roleName, RoleCreateRequest request)	Duplicates the current role.
RoleAgentPermission[]	getAgentPermissions(String roleName)	Returns the permissions of a role over agents.
RoleCampaignPermission[]	getCampaignPermissions(String roleName)	Returns the permissions of a role over campaigns.
RoleCategoryPermission[]	getCategoryPermissions(String roleName)	Returns the permissions of a role over categories.
RoleDirectoryPermission[]	getDirectoryPermissions(String roleName)	Returns the permissions of a role over directories.
RoleDocumentPermission[]	getDocumentPermissions(String roleName)	Returns the permissions of a role over documents.
IInstance	getInstance()	Returns the instance.
IRoleCursor	getRoleCursor(int cursorId)	Gets a role cursor open in the instance.
IRoleCursor[]	getRoleCursors()	Returns the role cursors open in the instance.
RoleData	getRoleDataById(int roleId)	Returns a RoleData object with data about the role.
RoleData	getRoleDataByName(String roleName)	Returns a RoleData object with data about the role.
String[]	getRoleNames()	Retrieves the list of role names.
RolePermission[]	getRolePermissions(String roleName)	Returns the permissions of a role over roles.
TableSchema	getRoleTableSchema()	Gets the table schema of the role.
RoleSavedReportPermission[]	getSavedReportPermissions(String roleName)	Returns the permissions of a role over saved reports.
RoleServicePermission[]	getServicePermissions(String roleName)	Returns the permissions of a role over services.
RoleSitePermission[]	getSitePermissions(String roleName)	Returns the permissions of a role over sites.
RoleTeamPermission[]	getTeamPermissions(String roleName)	Returns the permissions of a role over teams.
RoleWorkflowDefinitionPermission[]	getWorkflowDefinitionPermissions(String roleName)	Returns the permissions of a role over workflow definitions.
IRoleCursor	newRoleCursor(String[] columns, String sql)	Opens a role cursor.
IRoleCursor	tryGetRoleCursor(int cursorId)	Gets a role cursor open in the instance or null if it doesn't exist.
void	updateRole(String roleName, RoleUpdateRequest request)	Updates a role.

Methods inherited from interface IDisposable

addDisposedListener, removeDisposedListener

Methods inherited from interface IEntity

getUserContext, setUserContext

Method Details

deleteRole

void deleteRole(String roleName)
         throws Exception,
altitude.integrationServer.exceptions.ISException

Deletes a role.

Parameters:

roleName - Name of the role.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

duplicateRole

int duplicateRole(String roleName,
 RoleCreateRequest request)
           throws Exception,
altitude.integrationServer.exceptions.ISException

Duplicates the current role.

Parameters:

roleName - Name of the role to duplicate.

request - Role create request.

Returns:

Identifier of the duplicated role.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAgentPermissions

RoleAgentPermission[] getAgentPermissions(String roleName)
                                   throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the permissions of a role over agents.

Parameters:

roleName - Name of the role.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getCampaignPermissions

RoleCampaignPermission[] getCampaignPermissions(String roleName)
                                         throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the permissions of a role over campaigns.

Parameters:

roleName - Name of the role.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getCategoryPermissions

RoleCategoryPermission[] getCategoryPermissions(String roleName)
                                         throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the permissions of a role over categories.

Parameters:

roleName - Name of the role.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDirectoryPermissions

RoleDirectoryPermission[] getDirectoryPermissions(String roleName)
                                           throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the permissions of a role over directories.

Parameters:

roleName - Name of the role.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDocumentPermissions

RoleDocumentPermission[] getDocumentPermissions(String roleName)
                                         throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the permissions of a role over documents.

Parameters:

roleName - Name of the role.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInstance

IInstance getInstance()
               throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getRoleCursor

IRoleCursor getRoleCursor(int cursorId)
                   throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a role cursor open in the instance.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IRoleCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getRoleCursors

IRoleCursor[] getRoleCursors()
                      throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the role cursors open in the instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getRoleDataById

RoleData getRoleDataById(int roleId)
                  throws Exception,
altitude.integrationServer.exceptions.ISException

Returns a RoleData object with data about the role.

Parameters:

roleId - Identifier of the role.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getRoleDataByName

RoleData getRoleDataByName(String roleName)
                    throws Exception,
altitude.integrationServer.exceptions.ISException

Returns a RoleData object with data about the role.

Parameters:

roleName - Name of the role.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getRoleNames

String[] getRoleNames()
               throws Exception,
altitude.integrationServer.exceptions.ISException

Retrieves the list of role names.

Returns:

An array with the names of the roles.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getRolePermissions

RolePermission[] getRolePermissions(String roleName)
                             throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the permissions of a role over roles.

Parameters:

roleName - Name of the role.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getRoleTableSchema

TableSchema getRoleTableSchema()
                        throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the table schema of the role.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSavedReportPermissions

RoleSavedReportPermission[] getSavedReportPermissions(String roleName)
                                               throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the permissions of a role over saved reports.

Parameters:

roleName - Name of the role.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getServicePermissions

RoleServicePermission[] getServicePermissions(String roleName)
                                       throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the permissions of a role over services.

Parameters:

roleName - Name of the role.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSitePermissions

RoleSitePermission[] getSitePermissions(String roleName)
                                 throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the permissions of a role over sites.

Parameters:

roleName - Name of the role.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getTeamPermissions

RoleTeamPermission[] getTeamPermissions(String roleName)
                                 throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the permissions of a role over teams.

Parameters:

roleName - Name of the role.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getWorkflowDefinitionPermissions

RoleWorkflowDefinitionPermission[] getWorkflowDefinitionPermissions(String roleName)
                                                             throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the permissions of a role over workflow definitions.

Parameters:

roleName - Name of the role.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

newRoleCursor

IRoleCursor newRoleCursor(String[] columns,
 String sql)
                   throws Exception,
altitude.integrationServer.exceptions.ISException,
altitude.integrationServer.exceptions.ISSqlException

Opens a role cursor.

Parameters:

columns - Columns to fetch.

sql - SQL.

Returns:

The IRoleCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

altitude.integrationServer.exceptions.ISSqlException

tryGetRoleCursor

IRoleCursor tryGetRoleCursor(int cursorId)
                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a role cursor open in the instance or null if it doesn't exist.

Parameters:

cursorId - Identifier of the cursor.

Returns:

The IRoleCursor cursor.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

updateRole

void updateRole(String roleName,
 RoleUpdateRequest request)
         throws Exception,
altitude.integrationServer.exceptions.ISException

Updates a role.

Parameters:

roleName - Name of the role.

request - Role update request.

Throws:

Exception

altitude.integrationServer.exceptions.ISException