Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.base.stats
Interface ReportManager

All Known Implementing Classes:
AbstractReportManager, ForumsReportManager

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

getAvailableReports

Report[] getAvailableReports()
Returns an array of available reports in the system.


getReportCount

int getReportCount()
Returns the count of currently installed reports.


addReport

void addReport(Report report)
               throws UnauthorizedException
Installs a report. The same report can be installed more than once (can set different properties on each report).

Parameters:
report - the report to add.
Throws:
UnauthorizedException - if the user doesn't have system admin privileges.

getReport

Report getReport(int index)
Gets the installed report at index i.

Parameters:
index - the index of the report to get.
Returns:
the report installed at index i.

getReports

java.util.Iterator getReports()
Returns all installed reports as an iterator.


removeReport

void removeReport(int index)
                  throws UnauthorizedException
Uninstalls a report at the given index.

Parameters:
index - the index of the report to uninstall.
Throws:
UnauthorizedException - if the user does not have system admin privileges.

removeReports

void removeReports(int[] indexes)
                   throws UnauthorizedException
Uninstalls multiple reports at once.

Parameters:
indexes - an array of report indexes to uninstall.
Throws:
UnauthorizedException - if the user is not a system admin.

addReportClass

void addReportClass(java.lang.String className)
                    throws UnauthorizedException,
                           java.lang.ClassNotFoundException
Installs a new report, given the fully qualified classname of the report.

Parameters:
className - the fully qualified classname an instance of Report.
Throws:
UnauthorizedException - if the user is not a system admin.
java.lang.ClassNotFoundException - if the class specified is not found.

getAvailableTemplates

ReportTemplate[] getAvailableTemplates()
Returns a list of templates available in the system.


getTemplateCount

int getTemplateCount()
Returns a count of currently installed templates.


getTemplate

ReportTemplate getTemplate(int index)
Returns the template installed at the given index.


removeTemplate

void removeTemplate(int index)
                    throws UnauthorizedException
Uninstalls the specified template.

Parameters:
index - the index of the template to uninstall.
Throws:
UnauthorizedException - if the user is not a system admin.

addTemplateClass

void addTemplateClass(java.lang.String className)
                      throws UnauthorizedException,
                             java.lang.ClassNotFoundException
Installs a new template class, given the fully qualified classname of the template.

Parameters:
className - the fully qualified classname of the template and instance of ReportTemplate.
Throws:
UnauthorizedException - if the user is not a system admin.
java.lang.ClassNotFoundException - if the class specified is not found.

saveReports

void saveReports()
                 throws UnauthorizedException
Saves the report state.

Throws:
UnauthorizedException - if the user is not a system admin.

getGlobalStartDate

java.util.Date getGlobalStartDate()
Returns the globally specified start date for all reports.


setGlobalStartDate

void setGlobalStartDate(java.util.Date date)
                        throws UnauthorizedException
Sets the global date range for all reports.

Throws:
UnauthorizedException - if the user is not a system admin.

getGlobalEndDate

java.util.Date getGlobalEndDate()
Returns the globally specified end date for all reports.


setGlobalEndDate

void setGlobalEndDate(java.util.Date date)
                      throws UnauthorizedException
Sets the global end date for all reports.

Throws:
UnauthorizedException - if the user is not a system admin.

getExcludedObjectIDs

java.util.List getExcludedObjectIDs()
Returns a List of excluded object IDs (this is a list of objects that will be ignored when computing stats).


addExcludedObjectID

void addExcludedObjectID(long objectID)
Adds a objectID to the exclude list.


removeExcludeObjectID

void removeExcludeObjectID(long objectID)
Removes a objectID from the exclude list.


isEnableUserReports

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).


setEnableUserReports

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).


getOutputDir

java.io.File getOutputDir()
Returns the directory where reports are generated.

Returns:
the directory where reports are generated.
See Also:
setOutputDir(File)

setOutputDir

void setOutputDir(java.io.File outputDir)
Sets the directory where reports are generated. This method will not attempt to create the directory (that is done right before the reports are actually generated). Note, your VM needs to have write access to this directory.

Parameters:
outputDir - the directory where reports should be generated.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.