com.objectplanet.survey.plugin.api

Class ReportPortalManager

java.lang.Object

com.objectplanet.survey.plugin.api.ReportPortalManager

public class ReportPortalManager
extends java.lang.Object

Encapsulates functionality to manage report portals.

Author:

Eivind Pedersen

Constructor Summary

Constructors

Constructor and Description
ReportPortalManager()

Method Summary

Modifier and Type	Method and Description
static void	addPortalItem(long reportId, long portalId, java.lang.String name, java.lang.StringBuffer reportUrl) Adds an item to the portal.
static long	createPasswordProtectedReportPortal(java.lang.String reportName, java.lang.String password) Creates a password protected report portal.
static void	createReportPortal(java.lang.String portalName, java.lang.String password) Creates a new report portal with the given name.
static com.objectplanet.survey.reportportal.ReportPortal	getReportPortal(java.lang.String reportPortalName) Gets a report portal by the name.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReportPortalManager

public ReportPortalManager()

Method Detail

createReportPortal

public static void createReportPortal(java.lang.String portalName,
                                      java.lang.String password)
                               throws SurveySystemException

Creates a new report portal with the given name.

Parameters:

user - The user creating the portal

portalName - Name of new portal

Throws:

SurveySystemException

getReportPortal

public static com.objectplanet.survey.reportportal.ReportPortal getReportPortal(java.lang.String reportPortalName)

Gets a report portal by the name.

addPortalItem

public static void addPortalItem(long reportId,
                                 long portalId,
                                 java.lang.String name,
                                 java.lang.StringBuffer reportUrl)
                          throws SurveySecurityException,
                                 SurveySystemException

Adds an item to the portal.

Parameters:

reportId - The report id

portalId - The portal id

name - The name of the item

reportUrl - The report url

Throws:

SurveySecurityException

SurveySystemException

createPasswordProtectedReportPortal

public static long createPasswordProtectedReportPortal(java.lang.String reportName,
                                                       java.lang.String password)
                                                throws SurveySecurityException,
                                                       SurveySystemException

Creates a password protected report portal.

Parameters:

string -

password -

Returns:

Throws:

com.objectplanet.survey.exception.SurveySystemException

SurveySecurityException

SurveySystemException