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