View Javadoc

1   /**
2    * 
3    */
4   package de.tivsource.page.dao.manual;
5   
6   import java.util.List;
7   
8   import javax.ejb.Local;
9   
10  import de.tivsource.page.entity.manual.Manual;
11  
12  /**
13   * @author Marc Michele
14   *
15   */
16  @Local
17  public interface ManualDaoLocal {
18  
19      /**
20       * Methode zum speichern eines Objektes der Klasse Manual.
21       * @param manual - Manual Objekt das gespeichert werden soll
22       */
23      public void save(Manual manual);
24  
25      /**
26       * Methode zum verändern eines Objektes der Klasse Manual.
27       * @param manual - Manual Objekt das verändert werden soll
28       */
29      public void merge(Manual manual);
30  
31      /**
32       * Methode zum löschen eines Objektes der Klasse Manual.
33       * @param manual - zu löschendes Manual Objekt
34       */
35      public void delete(Manual manual);
36  
37      /**
38       * Metholde um zu überprüfen ob der angegebene UrlName zu einer Seite (Manual) gehört.
39       * 
40       * @param urlName - Der UrlName der überprüft werden soll.
41       * @return Boolean - true wenn es eine Seite (Manual) ist.
42       */
43      public Boolean isManualUuid(String uuid);
44      
45      /**
46       * Methode zum laden eines Objektes der Klasse Manual anhand der
47       * Uuid.
48       * 
49       * @param uuid - UUID des Objektes das geladen werden soll.
50       * @return Manual - Objekt das die angegebene UUID besitzt.
51       */
52      public Manual findByUuid(String uuid);
53  
54      /**
55       * Methode zum laden einer Liste von Manual Objekten, es muss dabei ein
56       * Startwert angegeben werden und die Anzahl der zu ladenen Manual Objekte.
57       *
58       * @param start - Startwert ab der die Liste beginnen soll
59       * @param max - Maximale Anzahl an Objekten die die Liste enthalten soll
60       * @return List<Manual> - Liste von Manual Objekten
61       */
62      public List<Manual> findAll(Integer start, Integer max);
63  
64      /**
65       * Methode zu laden einer Liste von Manual Objekten, es muss dabei ein
66       * Startwert, die Anzahl der zu ladenen Objekte, das Feld nach dem sortiert
67       * werden soll und die sortier Richtung angegeben werden.
68       * 
69       * @param start
70       * @param max
71       * @param field
72       * @param order
73       * @return
74       */
75      public List<Manual> findAll(Integer start, Integer max, String field, String order);
76  
77      public List<Manual> findAllVisible(Integer start, Integer max);
78  
79      /**
80       * Methode die die Anzahl aller Manual Objekte die sich in der Datenbank
81       * befinden zurück liefert.
82       *
83       * @return Integer - Anzahl der Manual Objekte die sich in der Datenbank befinden.
84       */
85      public Integer countAll();
86  
87      public Integer countAllVisible();
88  
89  }// Ende interface