01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. The ASF licenses this file to You
04: * under the Apache License, Version 2.0 (the "License"); you may not
05: * use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License. For additional information regarding
15: * copyright in this work, please see the NOTICE file in the top level
16: * directory of this distribution.
17: */
18:
19: package org.apache.roller.ui.rendering.pagers;
20:
21: import java.util.Map;
22:
23: /**
24: * Pager for weblog entries, handles latest, single-entry, month and day views.
25: * Collection returned is a list of lists of entries, where each list of
26: * entries represents one day.
27: */
28: public interface WeblogEntriesPager {
29:
30: /**
31: * A map of entries representing this collection.
32: *
33: * The collection is grouped by days of entries. Each value is a list of
34: * entry objects keyed by the date they were published.
35: */
36: public Map getEntries();
37:
38: /**
39: * Link value for returning to pager home
40: */
41: public String getHomeLink();
42:
43: /**
44: * Name of pager home.
45: */
46: public String getHomeName();
47:
48: /**
49: * Link value for next page in current collection view
50: */
51: public String getNextLink();
52:
53: /**
54: * Name for next page in current collection view
55: */
56: public String getNextName();
57:
58: /**
59: * Link value for prev page in current collection view
60: */
61: public String getPrevLink();
62:
63: /**
64: * Link value for prev page in current collection view
65: */
66: public String getPrevName();
67:
68: /**
69: * Link value for next collection view
70: */
71: public String getNextCollectionLink();
72:
73: /**
74: * Name for next collection view
75: */
76: public String getNextCollectionName();
77:
78: /**
79: * Link value for prev collection view
80: */
81: public String getPrevCollectionLink();
82:
83: /**
84: * Name for prev collection view
85: */
86: public String getPrevCollectionName();
87:
88: }
|