-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathIFeed.java
More file actions
145 lines (121 loc) · 4.22 KB
/
IFeed.java
File metadata and controls
145 lines (121 loc) · 4.22 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/* Copyright (c) 2008 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.gdata.data;
import com.google.gdata.client.Query;
import java.util.List;
/**
* Shared interface for model and data BaseFeed to implement.
*
*
*/
public interface IFeed extends IAtom {
/**
* Returns the value of the atom:logo element.
*/
public String getLogo();
/**
* Sets the value of the logo field on this feed.
*/
public void setLogo(String logo);
/**
* Returns the atom:subtitle element of this feed.
*/
public ITextConstruct getSubtitle();
/**
* Returns the atom:generator element on this feed.
*/
public IGenerator getGenerator();
/**
* Sets the atom:generator element on this feed. This method will create the
* appropriate type of element or extension based on the data model in use.
*/
public IGenerator setGenerator(String version, String uri, String name);
/**
* Returns true if this feed accepts entries POSTed to it.
*/
public boolean getCanPost();
/**
* Sets whether this feed accepts entries POSTed to it.
*/
public void setCanPost(boolean canPost);
/**
* Gets the total number of results associated with this feed. The value
* may be larger than the number of contained entries for paged feeds.
* A value of {@link Query#UNDEFINED} indicates the total size is undefined.
*/
public int getTotalResults();
/**
* Sets the total number of results associated with this feed. The value
* may be larger than the number of contained entries for paged feeds.
* A value of {@link Query#UNDEFINED} indicates the total size is undefined.
*/
public void setTotalResults(int totalResults);
/**
* Gets the starting index of the contained entries for paged feeds.
* A value of {@link Query#UNDEFINED} indicates the start index is undefined.
*/
public int getStartIndex();
/**
* Sets the starting index of the contained entries for paged feeds.
* A value of {@link Query#UNDEFINED} indicates the start index is undefined.
*/
public void setStartIndex(int startIndex);
/**
* Gets the number of items that will be returned per page for paged feeds.
* A value of {@link Query#UNDEFINED} indicates the page item count is
* undefined.
*/
public int getItemsPerPage();
/**
* Sets the number of items that will be returned per page for paged feeds.
* A value of {@link Query#UNDEFINED} indicates the page item count is
* undefined.
*/
public void setItemsPerPage(int numResults);
/**
* Creates a new entry of the appropriate type for this feed.
*/
public IEntry createEntry();
/**
* Returns a list of entries for this feed. The actual type of this list will
* depend on the data model used for the Feed.
*/
public List<? extends IEntry> getEntries();
/** Returns the entry post link for the feed. */
public ILink getEntryPostLink();
/**
* Returns the link that provides the URI of next page in a paged feed.
*
* @return Link that provides the URI of next page in a paged feed or {@code
* null} for none.
*/
public ILink getNextLink();
/**
* Returns the link that provides the URI of previous page in a paged feed.
*
* @return Link that provides the URI of previous page in a paged feed or
* {@code null} for none.
*/
public ILink getPreviousLink();
/**
* Returns the link that provides the URI that can be used to batch operations
* to query, insert, update and delete entries on this feed.
*
* @return Link that provides the URI that can be used to batch operations to
* query, insert, update and delete entries on this feed or {@code null}
* for none.
*/
public ILink getFeedBatchLink();
}