it.eng.spagobi.bo.dao
Interface IRoleDAO

All Known Implementing Classes:
RoleDAOHibImpl, RoleDAOImpl

public interface IRoleDAO

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

Author:
Zoppello

Method Summary
 void eraseRole(Role aRole)
          Implements the query to erase a role.
 void insertRole(Role aRole)
          Implements the query to insert a role.
 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.
 Role loadByID(java.lang.Integer roleID)
          Loads a role identified by its roleID.
 Role loadByName(java.lang.String roleName)
          Loads a role identified by its roleName.
 void modifyRole(Role aRole)
          Implements the query to modify a role.
 

Method Detail

loadByID

Role loadByID(java.lang.Integer roleID)
              throws 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:
EMFUserError - If an Exception occurred

loadByName

Role loadByName(java.lang.String roleName)
                throws 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:
EMFUserError - If an Exception occurred

loadAllRoles

java.util.List loadAllRoles()
                            throws 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:
EMFUserError - If an Exception occurred

insertRole

void insertRole(Role aRole)
                throws 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:
EMFUserError - If an Exception occurred

eraseRole

void eraseRole(Role aRole)
               throws 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:
EMFUserError - If an Exception occurred

modifyRole

void modifyRole(Role aRole)
                throws 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:
EMFUserError - If an Exception occurred

loadAllFreeRolesForInsert

java.util.List loadAllFreeRolesForInsert(java.lang.Integer parameterID)
                                         throws 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:
EMFUserError

loadAllFreeRolesForDetail

java.util.List loadAllFreeRolesForDetail(java.lang.Integer parUseID)
                                         throws 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:
EMFUserError