|
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 |
java.lang.Objectcom.jivesoftware.base.stats.AbstractReportManager
public abstract class AbstractReportManager
A base class implementation of the report manager interface.
Constructor Summary | |
---|---|
AbstractReportManager()
|
Method Summary | |
---|---|
void |
addExcludedObjectID(long objectID)
Adds an 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. |
protected abstract java.lang.String[] |
getPredefinedReportClasses()
|
Report |
getReport(int index)
Gets the installed report at index i. |
int |
getReportCount()
Returns the count of currently installed reports. |
protected java.lang.String |
getReportProp()
|
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 an object ID 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 |
save()
|
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AbstractReportManager()
Method Detail |
---|
protected abstract java.lang.String[] getPredefinedReportClasses()
protected java.lang.String getReportProp()
public Report[] getAvailableReports()
ReportManager
getAvailableReports
in interface ReportManager
public int getReportCount()
ReportManager
getReportCount
in interface ReportManager
public void addReport(Report report) throws UnauthorizedException
ReportManager
addReport
in interface ReportManager
report
- the report to add.
UnauthorizedException
- if the user doesn't have system admin privileges.public Report getReport(int index)
ReportManager
getReport
in interface ReportManager
index
- the index of the report to get.
public java.util.Iterator getReports()
ReportManager
getReports
in interface ReportManager
public void removeReport(int index) throws UnauthorizedException
ReportManager
removeReport
in interface ReportManager
index
- the index of the report to uninstall.
UnauthorizedException
- if the user does not have system admin privileges.public void removeReports(int[] indexes) throws UnauthorizedException
ReportManager
removeReports
in interface ReportManager
indexes
- an array of report indexes to uninstall.
UnauthorizedException
- if the user is not a system admin.public void saveReports()
ReportManager
saveReports
in interface ReportManager
public java.util.Date getGlobalStartDate()
ReportManager
getGlobalStartDate
in interface ReportManager
public void setGlobalStartDate(java.util.Date date) throws UnauthorizedException
ReportManager
setGlobalStartDate
in interface ReportManager
UnauthorizedException
- if the user is not a system admin.public java.util.Date getGlobalEndDate()
ReportManager
getGlobalEndDate
in interface ReportManager
public void setGlobalEndDate(java.util.Date date) throws UnauthorizedException
ReportManager
setGlobalEndDate
in interface ReportManager
UnauthorizedException
- if the user is not a system admin.public java.util.List getExcludedObjectIDs()
ReportManager
getExcludedObjectIDs
in interface ReportManager
public void addExcludedObjectID(long objectID)
addExcludedObjectID
in interface ReportManager
public void removeExcludeObjectID(long objectID)
removeExcludeObjectID
in interface ReportManager
public boolean isEnableUserReports()
ReportManager
isEnableUserReports
in interface ReportManager
public void setEnableUserReports(boolean enableUserReports)
ReportManager
setEnableUserReports
in interface ReportManager
public java.io.File getOutputDir()
ReportManager
getOutputDir
in interface ReportManager
ReportManager.setOutputDir(File)
public void setOutputDir(java.io.File outputDir)
ReportManager
setOutputDir
in interface ReportManager
outputDir
- the directory where reports should be generated.public void addReportClass(java.lang.String className) throws UnauthorizedException, java.lang.ClassNotFoundException
ReportManager
addReportClass
in interface ReportManager
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.public ReportTemplate[] getAvailableTemplates()
ReportManager
getAvailableTemplates
in interface ReportManager
public int getTemplateCount()
ReportManager
getTemplateCount
in interface ReportManager
public ReportTemplate getTemplate(int index)
ReportManager
getTemplate
in interface ReportManager
public void removeTemplate(int index) throws UnauthorizedException
ReportManager
removeTemplate
in interface ReportManager
index
- the index of the template to uninstall.
UnauthorizedException
- if the user is not a system admin.public void addTemplateClass(java.lang.String className) throws UnauthorizedException, java.lang.ClassNotFoundException
ReportManager
addTemplateClass
in interface ReportManager
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.public void save() throws UnauthorizedException
UnauthorizedException
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |