|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ContentRetrieval
Interface for accessing threads, messages, documents, and blog posts - all the fundamental content elements
in the system. The object implementing this interface can either be the logical container of those content elements
(like a ForumCategory
)).
ForumCategory
Field Summary | |
---|---|
static long[] |
ALL_TYPES
An array of all ContentTypes |
static long |
THREAD
|
Method Summary | |
---|---|
java.util.Iterator |
getCombinedContent(long[] types)
Returns an Iterable for all threads, documents, and blog posts in the community, depending on which ContentTypes are supplied as an argument. |
java.util.Iterator |
getCombinedContent(ResultFilter filter,
long[] types)
Returns an Iterable for all threads, documents, and blog posts in the community, depending on which ContentTypes are supplied as an argument, and according the the supplied ResultFilter . |
int |
getCombinedContentCount(long[] types)
Returns the combined number of threads, documents, and blog posts in the community, depending on which ContentTypes are supplied as an argument. |
int |
getCombinedContentCount(ResultFilter filter,
long[] types)
Returns the combined number of threads, documents, and blog posts in the community, depending on which ContentTypes are supplied as an argument, and restricted by the ResultFilter. |
int |
getMessageCount()
Returns the number of messages in the community. |
int |
getMessageCount(ResultFilter filter)
Returns the number of messages in the community based on the specified ResultFilter. |
java.util.Iterator |
getMessages()
Returns an Iterable for all the messages in the community. |
java.util.Iterator |
getMessages(ResultFilter filter)
Returns an Iterable for all the messages in the community that match the criteria specified by the ResultFilter. |
int |
getThreadCount()
Returns the number of threads in the community. |
int |
getThreadCount(ResultFilter resultFilter)
Returns the number of threads in the community based on the specified ResultFilter. |
java.util.Iterator |
getThreads()
Returns an Iterable for all the threads in the community. |
java.util.Iterator |
getThreads(ResultFilter resultFilter)
Returns an Iterable for all the threads in the community that match the criteria specified by the ResultFilter. |
Field Detail |
---|
static final long THREAD
static final long[] ALL_TYPES
Method Detail |
---|
int getCombinedContentCount(long[] types)
getCombinedContent(long[])
method.
types
- the ContentTypes to include in the count.
int getCombinedContentCount(ResultFilter filter, long[] types)
getCombinedContent(ResultFilter, long[])
method.
filter
- the ResultFilter
to filter the results.types
- the ContentTypes to include in the count.
java.util.Iterator getCombinedContent(long[] types)
types
- the ContentTypes to include in the result.
java.util.Iterator getCombinedContent(ResultFilter filter, long[] types)
ResultFilter
.
filter
- the ResultFilter
to filter and sort the results.types
- the ContentTypes to include in the result.
int getThreadCount()
getThreads()
method.
int getThreadCount(ResultFilter resultFilter)
getThreads(com.jivesoftware.forum.ResultFilter)
method.
resultFilter
- a resultFilter to limit the query on.
java.util.Iterator getThreads()
java.util.Iterator getThreads(ResultFilter resultFilter)
resultFilter
- a ResultFilter object to perform filtering and sorting with.
int getMessageCount()
getMessages()
method.
int getMessageCount(ResultFilter filter)
getMessages(ResultFilter)
method.
filter
- a resultFilter to limit the query on.
java.util.Iterator getMessages()
java.util.Iterator getMessages(ResultFilter filter)
filter
- a ResultFilter object to perform filtering and sorting with.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |