1 package atg.util.service.list;
2
3 import java.io.Serializable;
4 import java.util.Vector;
5
6 import atg.metier.entite.ATGIEntite;
7
8 /**
9 * <p>
10 * Titre : Interface cliente de ATGListEntity
11 * </p>
12 * <p>
13 * Description : Interface permettant d'accéder seulement aux méthodes getters
14 * de l'objet ATGListEntity
15 * </p>
16 * <p>
17 * Copyright : FERRARI Olivier
18 * </p>
19 *
20 * @author FERRARI Olivier modifié par YSMAL Vincent
21 * @version 1.2 Passage en 1.5 . Generic 1.1 Ce logiciel est régi par la licence
22 * CeCILL soumise au droit français et respectant les principes de
23 * diffusion des logiciels libres. Vous pouvez utiliser, modifier et/ou
24 * redistribuer ce programme sous les conditions de la licence CeCILL
25 * telle que diffusée par le CEA, le CNRS et l'INRIA sur le site
26 * http://www.cecill.info.
27 *
28 * Le fait que vous puissiez accéder à cet en-tête signifie que vous avez pris
29 * connaissance de la licence CeCILL, et que vous en avez accepté les termes.
30 */
31 public interface ATGIListEntity<K extends ATGIEntite> extends Serializable {
32
33 /**
34 * Retourne la liste complète de VO
35 *
36 * @return Liste de VOs
37 * @throws ATGListException
38 */
39 public Vector<K> getListeAll() throws ATGListException;
40
41 /**
42 * Retourne le nombre de pages de NombreParPage éléments
43 *
44 * @return le nombre de pages de NombreParPage éléments
45 */
46 public int getNbPages() throws ATGListException;
47
48 /**
49 * Retourne une liste de NombreParPage elements correspondante à la page en
50 * paramètre
51 *
52 * @param page
53 * Numéro de la page de 1 à N (si <=0 : 1 par défaut. si > nb
54 * page : nb page par défaut)
55 * @return Liste de Entitys
56 * @throws ATGListException
57 */
58 public Vector<K> getListePage(int page) throws ATGListException;
59
60 /**
61 * Retourne la liste des premiers éléments par lot de NombreParPage
62 *
63 * @return un vecteur contenant la premiere liste de N entités
64 * @throws ATGListException
65 */
66 public Vector<K> getListePremier() throws ATGListException;
67
68 /**
69 * Retourne la dernière liste de VO
70 *
71 * @return un vecteur contenant la derniere liste de 1 à N entités
72 * @throws ATGListException
73 */
74 public Vector<K> getListeDernier() throws ATGListException;
75
76 /**
77 * Retourne la liste suivante de VO par rapport à l'index en cours
78 *
79 * @return un vecteur contenant la liste suivante de N entités
80 * @throws ATGListException
81 */
82 public Vector<K> getListeSuivante() throws ATGListException;
83
84 /**
85 * Retourne la liste précédente de VO par rapport à l'index en cours
86 *
87 * @return un vecteur contenant la liste precedente de N entités
88 * @throws ATGListException
89 */
90 public Vector<K> getListePrecedente() throws ATGListException;
91
92 /**
93 * Retourne l'index Minimun de la liste renvoyée
94 *
95 * @return index maximum de la liste renvoyée
96 * @throws ATGListException
97 */
98 public int getIndexMiniListeRenvoyee() throws ATGListException;
99
100 /**
101 * Retourne l'index maximum de la liste renvoyée
102 *
103 * @return index maximum de la liste renvoyée
104 * @throws ATGListException
105 */
106 public int getIndexMaxiListeRenvoyee() throws ATGListException;
107
108 /**
109 * Retourne le nombre total de la liste
110 *
111 * @return nombre total d'enregistrement dans la liste
112 * @throws ATGListException
113 */
114 public int getTotalEnregistrement() throws ATGListException;
115
116 /**
117 * Positionnement de l'index en cours
118 *
119 * @param index
120 * Index de parcour de liste
121 */
122 public void setIndexEnCours(int index);
123
124 }