|
Jive Forums API (5.5.20.2-oracle) Core Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface QueryLogger
This manager provides methods to retrieve query objects previously used for searching either the whole system or just in particular forums.
Method Summary | |
---|---|
java.util.Map |
getLoggedQueryInfo(Query query)
Returns the logged information about the query, or null if the query has not been logged yet. |
java.util.Iterator |
getQueries()
Returns an iterator of all the queries that have been made. |
java.util.Iterator |
getQueries(User user)
Returns an Iterator consisting of all the Query's that the specified user has made. |
Query |
getQuery(long queryID)
Returns the query associated with the given queryID. |
int |
getQueryCount()
Returns a count of all the queries that have been made in the system. |
int |
getQueryCount(User user)
Returns a count of all the queries that the user has made. |
Method Detail |
---|
int getQueryCount() throws UnauthorizedException
UnauthorizedException
- if not a System Administratorint getQueryCount(User user) throws UnauthorizedException
user
- the user to return the query count for.
UnauthorizedException
- if not a System Administrator or the specified user.java.util.Iterator getQueries() throws UnauthorizedException
UnauthorizedException
- if not a System Administratorjava.util.Iterator getQueries(User user) throws UnauthorizedException
user
- the user to return the query count for.
UnauthorizedException
- if not a System Administrator or the specified user.Query getQuery(long queryID) throws NotFoundException, UnauthorizedException
queryID
- the id of the query to retrieve
NotFoundException
- if the query associated with the queryID cannot be found.
UnauthorizedException
- if not the user who issued the query or an administrator.java.util.Map getLoggedQueryInfo(Query query)
Key (String) | Value |
---|---|
searchDuration | Integer |
numResults | Integer |
searchDate | Date |
categories | KbCategory[] or null if none specified (searching all categories) |
query
-
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |