|
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 ReportManager
Main report manager inferface. Report management (add, delete, update, etc) is done
through this interface while report generation is handled through the AbstractReportRunner
class.
Method Summary | |
---|---|
void |
addExcludedObjectID(long objectID)
Adds a objectID to the exclude list. |
void |
addReport(Report report)
Installs a report. |
void |
addReportClass(java.lang.String className)
Installs a new report, given the fully qualified classname of the report. |
void |
addTemplateClass(java.lang.String className)
Installs a new template class, given the fully qualified classname of the template. |
Report[] |
getAvailableReports()
Returns an array of available reports in the system. |
ReportTemplate[] |
getAvailableTemplates()
Returns a list of templates available in the system. |
java.util.List |
getExcludedObjectIDs()
Returns a List of excluded object IDs (this is a list of objects that will be ignored when computing stats). |
java.util.Date |
getGlobalEndDate()
Returns the globally specified end date for all reports. |
java.util.Date |
getGlobalStartDate()
Returns the globally specified start date for all reports. |
java.io.File |
getOutputDir()
Returns the directory where reports are generated. |
Report |
getReport(int index)
Gets the installed report at index i. |
int |
getReportCount()
Returns the count of currently installed reports. |
java.util.Iterator |
getReports()
Returns all installed reports as an iterator. |
ReportTemplate |
getTemplate(int index)
Returns the template installed at the given index. |
int |
getTemplateCount()
Returns a count of currently installed templates. |
boolean |
isEnableUserReports()
Returns true if user reports should be run (admins might wish to disable them if their system is integrated with a 3rd party user system). |
void |
removeExcludeObjectID(long objectID)
Removes a objectID from the exclude list. |
void |
removeReport(int index)
Uninstalls a report at the given index. |
void |
removeReports(int[] indexes)
Uninstalls multiple reports at once. |
void |
removeTemplate(int index)
Uninstalls the specified template. |
void |
saveReports()
Saves the report state. |
void |
setEnableUserReports(boolean enableUserReports)
Sets whether or not to enable user reports (admins might wish to disable them if their system is integrated with a 3rd party user system). |
void |
setGlobalEndDate(java.util.Date date)
Sets the global end date for all reports. |
void |
setGlobalStartDate(java.util.Date date)
Sets the global date range for all reports. |
void |
setOutputDir(java.io.File outputDir)
Sets the directory where reports are generated. |
Method Detail |
---|
Report[] getAvailableReports()
int getReportCount()
void addReport(Report report) throws UnauthorizedException
report
- the report to add.
UnauthorizedException
- if the user doesn't have system admin privileges.Report getReport(int index)
index
- the index of the report to get.
java.util.Iterator getReports()
void removeReport(int index) throws UnauthorizedException
index
- the index of the report to uninstall.
UnauthorizedException
- if the user does not have system admin privileges.void removeReports(int[] indexes) throws UnauthorizedException
indexes
- an array of report indexes to uninstall.
UnauthorizedException
- if the user is not a system admin.void addReportClass(java.lang.String className) throws UnauthorizedException, java.lang.ClassNotFoundException
className
- the fully qualified classname an instance of Report
.
UnauthorizedException
- if the user is not a system admin.
java.lang.ClassNotFoundException
- if the class specified is not found.ReportTemplate[] getAvailableTemplates()
int getTemplateCount()
ReportTemplate getTemplate(int index)
void removeTemplate(int index) throws UnauthorizedException
index
- the index of the template to uninstall.
UnauthorizedException
- if the user is not a system admin.void addTemplateClass(java.lang.String className) throws UnauthorizedException, java.lang.ClassNotFoundException
className
- the fully qualified classname of the template and instance of ReportTemplate
.
UnauthorizedException
- if the user is not a system admin.
java.lang.ClassNotFoundException
- if the class specified is not found.void saveReports() throws UnauthorizedException
UnauthorizedException
- if the user is not a system admin.java.util.Date getGlobalStartDate()
void setGlobalStartDate(java.util.Date date) throws UnauthorizedException
UnauthorizedException
- if the user is not a system admin.java.util.Date getGlobalEndDate()
void setGlobalEndDate(java.util.Date date) throws UnauthorizedException
UnauthorizedException
- if the user is not a system admin.java.util.List getExcludedObjectIDs()
void addExcludedObjectID(long objectID)
void removeExcludeObjectID(long objectID)
boolean isEnableUserReports()
void setEnableUserReports(boolean enableUserReports)
java.io.File getOutputDir()
setOutputDir(File)
void setOutputDir(java.io.File outputDir)
outputDir
- the directory where reports should be generated.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |