IBrolDao.cs

using System;
using System.Collections.Generic;
using System.Text;
using System.Data;
using be.gaudry.observer;
 
namespace be.gaudry.bibliobrol.model.dao
{
    public interface IBrolDao : IObservable
    {
 
        /// <summary>
        /// Load all roles
        /// </summary>
        /// <returns></returns>
        List<ActorRole> loadRoles();
        /// <summary>
        /// Load roles for a person
        /// </summary>
        /// <param name="person"></param>
        /// <returns></returns>
        List<ActorRole> loadRoles(Person person);
        /// <summary>
        /// Load the default role for a person
        /// </summary>
        /// <param name="person"></param>
        /// <returns></returns>
        ActorRole loadDefaultRole(Person person);
        /// <summary>
        /// set the default role for a person
        /// </summary>
        /// <param name="person"></param>
        /// <param name="role"></param>
        void setDefaultRole(Person person, ActorRole role);
        /// <summary>
        /// Load person's roles for the selected type 
        /// </summary>
        /// <param name="brolType"></param>
        /// <returns>List of roles strings</returns>
        List<ActorRole> loadRoles(BrolType brolType);
        /// <summary>
        /// get a roles with the id
        /// </summary>
        /// <param name="roleId">(int) id of the requested role</param>
        /// <returns>l(ActorRole) requested role</returns>
        ActorRole loadRole(int roleId);
        /// <summary>
        /// get a roles with the name
        /// </summary>
        /// <param name="roleName">(string) name of the requested role</param>
        /// <returns>(ActorRole) requested role</returns>
        ActorRole loadRole(string roleName);
        /// <summary>
        /// get a list of roles with the same name
        /// </summary>
        /// <param name="roleName">(string) name of the requested roles</param>
        /// <returns>(List of ActorRole) requested roles</returns>
        List<ActorRole> loadRoles(string roleName);
        /// <summary>
        /// Insert a new role. Don't check if the role name exists in the db. You must do it before.
        /// </summary>
        /// <param name="actor">(ActorRole) role to add</param>
        /// <returns></returns>
        bool insertRole(ActorRole role);
        /// <summary>
        /// Insert a brol (i.e. a film) into the Access database
        /// </summary>
        /// <param name="brol">(Brol) brol to insert</param>
        /// <returns>(int) new brol id</returns>
        int insertBrol(Brol brol);
        int insertBrols(List<Brol> brols, bool insertMediabrol);
        /// <summary>
        /// Load a brol with the selected id from the Access database. 
        /// If this brol shoud be modified, editing bool arg is true
        /// to avoid concurent modifications (nobody else can save this brol).
        /// </summary>
        /// <param name="id">(int) Id of the selected bool</param>
        /// <param name="editing">(bool) Shoud be modified or not</param>
        /// <returns>Selected bool, or a new bool if _ found</returns>
        Brol loadBrol(int id, bool editing);
        /// <summary>
        /// Load all brols for a type from the persistant layer. 
        /// i.e. films, books, etc.
        /// typeId 0 allow to load all types
        /// </summary>
        /// <returns>List of Brols</returns>
        List<Brol> loadBrols(int typeId);
        /// <summary>
        /// Load all brols for a serie from the persistant layer.
        /// </summary>
        /// <param name="serie"></param>
        /// <returns>List of Brols</returns>
        List<Brol> loadBrols(Serie serie);
        /// <summary>
        /// Load all available categories for a type from the Access database. 
        /// i.e. for a film : Science-fiction, Horror, etc.
        /// </summary>
        /// <param name="typeId">(int) selected type (film, book, etc.) negative value to load all</param>
        /// <returns>List of BrolCategories</returns>
        List<BrolCategory> loadCategories(int typeId);
        /// <summary>
        /// Load brols value objects (only selected fields) for a type from the Access database. 
        /// </summary>
        /// <param name="fields">List of fields to load for the brols</param>
        /// <param name="typeId">
        /// (int) selected type (film, book, etc.)
        /// 0 allow to load all types
        /// </param>
        /// <returns>DataTable with selected fields for Brols</returns>
        DataTable loadDataTableVos(List<DAOUtils.BROL_FIELD> fields, int typeId);
        /// <summary>
        /// Store new values for a brol. 
        /// Verify if some categories or actors had been deleted, and delete it from the persistant layer. 
        /// Add new categories or actors if exists. 
        /// Update existing categories or actors.
        /// </summary>
        /// <param name="person">(Brol) brol with new values to store</param>
        /// <returns>(bool) true if update is done</returns>
        bool updateBrol(Brol brol);
        /// <summary>
        /// Lock brol to avoid concurent modifications.
        /// </summary>
        /// <param name="id">(int) brol's id to lock</param>
        /// <returns>(bool) false if a problem occurs (todo : if already locked)</returns>
        bool lockBrol(int id);
        /// <summary>
        /// unlock brol to allow modifications.
        /// </summary>
        /// <param name="id">(int) brol's id to unlock</param>
        void unlockBrol(int id);
        /// <summary>
        /// Delete a brol from the Access database, 
        /// and delete all associated actors and categories
        /// </summary>
        /// <param name="p">(Brol) brol to delete</param>
        /// <returns>(bool) true if deleted</returns>
        bool deleteBrol(Brol brol);
        /// <summary>
        /// Insert brols from a batch file (batch filePath is stored into application properties file)
        /// </summary>
        /// <param name="insertMediabrol">(bool) True if a mediabrol must be inserted for each brol</param>
        /// <returns>(int) Number of inserted brols</returns>
        int executeBatch(bool insertMediabrol);
    }
}