it.eng.spagobi.commons.dao
Interface IRoleDAO

All Superinterfaces:
ISpagoBIDao
All Known Implementing Classes:
RoleDAOHibImpl

public interface IRoleDAO
extends ISpagoBIDao

Defines the interfaces for all methods needed to insert, modify and deleting a role

Author:
Zoppello

Method Summary
 java.lang.Integer countRoles()
           
 void eraseRole(it.eng.spagobi.commons.bo.Role aRole)
          Implements the query to erase a role.
 java.util.List<it.eng.spagobi.commons.bo.RoleMetaModelCategory> getMetaModelCategoriesForRole(java.lang.Integer roleId)
           
 void insertRole(it.eng.spagobi.commons.bo.Role aRole)
          Implements the query to insert a role.
 java.lang.Integer insertRoleComplete(it.eng.spagobi.commons.bo.Role aRole)
          Implements the query to insert a role.
 void insertRoleMetaModelCategory(java.lang.Integer roleId, java.lang.Integer categoryId)
           
 java.util.List loadAllFreeRolesForDetail(java.lang.Integer parUseID)
          Gets all free roles for detail.
 java.util.List loadAllFreeRolesForInsert(java.lang.Integer parameterID)
          Gets all free roles for Insert.
 java.util.List loadAllRoles()
          Loads all detail information for all roles.
 it.eng.spagobi.commons.bo.Role loadByID(java.lang.Integer roleID)
          Loads a role identified by its roleID.
 it.eng.spagobi.commons.bo.Role loadByName(java.lang.String roleName)
          Loads a role identified by its roleName.
 java.util.List LoadFunctionalitiesAssociated(java.lang.Integer roleID)
          Gets all the functionalities associated to the role.
 java.util.List<it.eng.spagobi.commons.bo.Role> loadPagedRolesList(java.lang.Integer offset, java.lang.Integer fetchSize)
           
 java.util.List LoadParUsesAssociated(java.lang.Integer roleID)
          Gets all the parameter uses associated to the role.
 SbiExtRoles loadSbiExtRoleById(java.lang.Integer roleId)
           
 void modifyRole(it.eng.spagobi.commons.bo.Role aRole)
          Implements the query to modify a role.
 void removeRoleMetaModelCategory(java.lang.Integer roleId, java.lang.Integer categoryId)
           
 
Methods inherited from interface it.eng.spagobi.commons.dao.ISpagoBIDao
getUserProfile, setTenant, setUserID, setUserProfile
 

Method Detail

loadByID

it.eng.spagobi.commons.bo.Role loadByID(java.lang.Integer roleID)
                                        throws it.eng.spago.error.EMFUserError
Loads a role identified by its roleID. All these information, are stored into a Role object, which is returned.

Parameters:
roleID - The id for the role to load
Returns:
A Role object containing all loaded information
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

loadSbiExtRoleById

SbiExtRoles loadSbiExtRoleById(java.lang.Integer roleId)
                               throws it.eng.spago.error.EMFUserError
Throws:
it.eng.spago.error.EMFUserError

loadByName

it.eng.spagobi.commons.bo.Role loadByName(java.lang.String roleName)
                                          throws it.eng.spago.error.EMFUserError
Loads a role identified by its roleName. All these information, are stored into a Role object, which is returned.

Parameters:
roleName - The name for the role to load
Returns:
A Role object containing all loaded information
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

loadAllRoles

java.util.List loadAllRoles()
                            throws it.eng.spago.error.EMFUserError
Loads all detail information for all roles. For each of them, detail information is stored into a Role object. After that, all roles are stored into a List, which is returned.

Returns:
A list containing all role objects
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

insertRole

void insertRole(it.eng.spagobi.commons.bo.Role aRole)
                throws it.eng.spago.error.EMFUserError
Implements the query to insert a role. All information needed is stored into the input Role object.

Parameters:
aRole - The object containing all insert information
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

eraseRole

void eraseRole(it.eng.spagobi.commons.bo.Role aRole)
               throws it.eng.spago.error.EMFUserError
Implements the query to erase a role. All information needed is stored into the input Role object.

Parameters:
aRole - The object containing all delete information
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

modifyRole

void modifyRole(it.eng.spagobi.commons.bo.Role aRole)
                throws it.eng.spago.error.EMFUserError
Implements the query to modify a role. All information needed is stored into the input Role object.

Parameters:
aRole - The object containing all modify information
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

loadAllFreeRolesForInsert

java.util.List loadAllFreeRolesForInsert(java.lang.Integer parameterID)
                                         throws it.eng.spago.error.EMFUserError
Gets all free roles for Insert. When a parameter has some parameter use modes associated, this association happens with one or more roles. For the same parameter, roles belonging to a parameter use mode cannot be assigned to others. So, when a new parameter use mode has to be inserted/modifies, this methods gives the roles that are still free.

Parameters:
parameterID - The parameter id
Returns:
The free roles list
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

loadAllFreeRolesForDetail

java.util.List loadAllFreeRolesForDetail(java.lang.Integer parUseID)
                                         throws it.eng.spago.error.EMFUserError
Gets all free roles for detail. When a parameter has some parameter use modes associated, this association happens with one or more roles. For the same parameter, roles belonging to a parameter use mode cannot be assigned to others. So, when a parameter use mode detail is required, this methods gives the roles that are still free.

Parameters:
parUseID - The parameter use mode id
Returns:
The free roles list
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

LoadFunctionalitiesAssociated

java.util.List LoadFunctionalitiesAssociated(java.lang.Integer roleID)
                                             throws it.eng.spago.error.EMFUserError
Gets all the functionalities associated to the role.

Parameters:
roleID - The role id
Returns:
The functionalities associated to the role
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

LoadParUsesAssociated

java.util.List LoadParUsesAssociated(java.lang.Integer roleID)
                                     throws it.eng.spago.error.EMFUserError
Gets all the parameter uses associated to the role.

Parameters:
roleID - The role id
Returns:
The parameter uses associated to the role
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

insertRoleComplete

java.lang.Integer insertRoleComplete(it.eng.spagobi.commons.bo.Role aRole)
                                     throws it.eng.spago.error.EMFUserError
Implements the query to insert a role. All information needed is stored into the input Role object.

Parameters:
aRole - The object containing all insert information, includig the role abilitations
Returns:
The role id
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

loadPagedRolesList

java.util.List<it.eng.spagobi.commons.bo.Role> loadPagedRolesList(java.lang.Integer offset,
                                                                  java.lang.Integer fetchSize)
                                                                  throws it.eng.spago.error.EMFUserError
Throws:
it.eng.spago.error.EMFUserError

countRoles

java.lang.Integer countRoles()
                             throws it.eng.spago.error.EMFUserError
Throws:
it.eng.spago.error.EMFUserError

insertRoleMetaModelCategory

void insertRoleMetaModelCategory(java.lang.Integer roleId,
                                 java.lang.Integer categoryId)
                                 throws it.eng.spago.error.EMFUserError
Throws:
it.eng.spago.error.EMFUserError

removeRoleMetaModelCategory

void removeRoleMetaModelCategory(java.lang.Integer roleId,
                                 java.lang.Integer categoryId)
                                 throws it.eng.spago.error.EMFUserError
Throws:
it.eng.spago.error.EMFUserError

getMetaModelCategoriesForRole

java.util.List<it.eng.spagobi.commons.bo.RoleMetaModelCategory> getMetaModelCategoriesForRole(java.lang.Integer roleId)
                                                                                              throws it.eng.spago.error.EMFUserError
Throws:
it.eng.spago.error.EMFUserError