Style Intelligence v12.0

inetsoft.sree
Interface RepletRepository

All Superinterfaces:
Remote
All Known Subinterfaces:
AnalyticRepository
All Known Implementing Classes:
RepletEngine

public interface RepletRepository
extends Remote

This defines the server side report engine interface for processing replets.


Field Summary
static int ADDTOQ_FAILURE
          The task of add to queue is failure.
static int ADDTOQ_GENERATION
          The task of add to queue is failed,because page is generated.
static int ADDTOQ_SUCCESS
          The task of add to queue is success.
static int AUTO_REPLET
          Flag indicating this report is we auto created report, not created by user.
static int DEFAULT_ARCHIVE
          The default (file-based) archive type is supported.
static int NO_ARCHIVE
          No archive is supported.
static int NOT_CHECK_PERMISSION
          Flag indicating this report doesn't need to check permission.
static int PREGENERATE
          Create a replet for pre-generation of report output (both bursting and regular reports) only.
static String PRINCIPAL_COOKIE
          HTTP session key for the user principal.
static int REPLET
          Create a standard replet.
static int REPLET_MASK
          Flag to filter out other hints, then only replet type left.
static int REPORT
          Create a replet for use in the adhoc editing mode.
static int VERSIONED_ARCHIVE
          The version-controlled archive type is supported.
static String VIRTUAL_REPLET
          Virtual replet.
 
Method Summary
 void addFolder(RepositoryEntry entry, String name, String alias, String description, Principal user)
          Add folder of a repository entry.
 int addToQueue(Object repletId, String replet, Principal user)
          Add a replet to queue when loading.
 Principal authenticate(ClientInfo user, Object credential)
          Authenticate a specific entity.
 void cancel(Object repletId)
          Cancel a replet execution.
 void changeFolder(RepositoryEntry entry, String folder, Principal user)
          Change folder of a repository entry.
 void changePassword(Principal principal, String password)
          Change the password of the specified user.
 boolean checkPermission(Principal principal, String resource, char access)
          Check if a user has permission for the specified access to a resource.
 boolean containsFolder(Principal principal, String permission)
          Check if a user could access folders.
 boolean containsParameterSheet(Object repletId)
          Check if the replet contains parameter sheets.
 Object createReplet(Object name, Principal principal, int type)
          Create an instance of the specified replet.
 Image createThumbnail(String name, String version, Principal user)
          Creates a thumbnail image for a report.
 void destroy(Object repletId, int type)
          Destroy a replet instance.
 void disableParameterSheet(Object repletId)
          Disable parameter sheets contained in the replet, and all the parameter sheets will be ignored when process replet.
 Object export(Object repletId, int format)
          Export a replet to the specified format.
 PageLocation find(Object repletId, SearchCondition cond, PageLocation start)
          Search a replet to find the location in the report that meets the specified search criteria.
 void generateReplet(Object repletId, RepletRequest request)
          Generate a report from the specified replet instance.
 Object[] getActiveReplets(String user)
          Get active replet ids.
 int getArchiveOption()
          Get the type of archive that is supported.
 Object[] getArchiveReplets(Principal user)
          Get archive replets by principal.
 Object getArchiveReport(String path, String version, Principal principal)
          Open an archived report.
 EventHandler getEventHandler(Object repletId)
          Get the client-side command event handler for the specified replet.
 int getEventMask(Object repletId)
          Return the bitwise OR of all event flags for the events that this replet wants to receive.
 RepositoryEntry[] getFolders(Principal principal, String permission)
          Get the list of all folders.
 HeadingTarget[] getHeadingTargets(Object repletId)
          Get the targets pointing to heading elements.
 StylePage getPage(Object repletId, int page)
          Get a single page of a report.
 int getPageCount(Object repletId)
          Get the number of pages in a report.
 PageLocation getPageLocation(Object repletId, String elementId, Point item)
          Get the location of a specific element in a report.
 String[] getPrinters()
          Get the names of all printers available to the server.
 Vector getPrintPages(Object repletId, int[] printPages, int fmt)
          Get the corresponding pages of specified replet for print.
 int getProcessStatus(Object id)
          Get the process status of a report.
 String getProperty(String name)
          Get the value of a specified property.
 inetsoft.sree.internal.QueuedRepletInfo[] getQueuedReplets(Principal user)
          Get replets information in the report queue.
 SelectionEvent[] getRegisteredSelections(Object repletId)
          Get the selection events that are registerd with a specific replet.
 RepletContext getRepletContext(Object repletId)
          Get contextual information about a specfic replet.
 RepletParameters getRepletParameters(Object repletId, String request)
          Get the report parameters for a specified replet.
 RepositoryEntry[] getReplets(Principal principal, String permission)
          Get the list of all replets.
 String getReportProperty(Object rid, Object key)
          Get report property.
 Size getReportSize(String name, String version, Principal user)
          Gets the size of a report.
 RepositoryEntry[] getRepositoryEntries(String folder, Principal user, String permission, int selector)
          Get available repository entries.
 long getResourceLength(Object resourceId)
          Get the size, in bytes, of the specified resource.
 ScheduleTask getScheduleTask(String name)
          Get the schedule task with the specified name.
 String[] getScheduleTasks(Principal principal)
          Get a list of schedule tasks available to the specified user.
 Enumeration getSingleStylePage(Object repletId)
          Get a single style page of the specified replet.
 RepletCommand handleEvent(Object repletId, EventObject event)
          Handle a viewer event on the report server.
 boolean isFolderChanged(String folder, Principal user)
          Check if the tree change, response the refresh option to refresh the tree of portal page.
 boolean isParameterSheet(Object repletId)
          Check if current report sheet is a parameter sheet.
 void logout(Principal principal)
          Log the specified user out of the system.
 void mailTo(Object repletId, String recipients, String ccAddress, String bccAddress, String from, String subject, String msg, String fmt)
          Send a replet via email which includes "CC" and "BCC" addresses.
 void mailTo(Object repletId, String recipients, String ccAddress, String bccAddress, String from, String subject, String msg, String fmt, boolean compress)
          Send a replet via email which includes "CC" and "BCC" addresses.
 void mailTo(Object repletId, String recipients, String ccAddress, String bccAddress, String from, String subject, String msg, String fmt, boolean compress, String attachmentName)
          Send a replet via email which includes "CC" and "BCC" addresses.
 void mailTo(Object repletId, String recipients, String ccAddress, String bccAddress, String from, String subject, String msg, String fmt, boolean compress, String attachmentName, String password)
          Send a replet via email which includes "CC" and "BCC" addresses.
 void mailTo(Object repletId, String recipients, String ccAddress, String bccAddress, String from, String subject, String msg, String fmt, boolean compress, String attachmentName, String password, boolean htmlContent)
          Send a replet via email which includes "CC" and "BCC" addresses.
 byte[] nextBlock(Object resourceId)
          Get the next block of data in a specified resource.
 void print(Object repletId, String printer, int[] pageList)
          Print a range of pages of a replet to the specified server printer.
 boolean removeFromQueue(Object repletId, Principal user)
          Remove a replet from queue.
 void removeRepositoryEntry(RepositoryEntry entry, Principal user)
          Remove a repostory entry.
 void removeScheduleTask(Principal principal, String name)
          Remove a scheduled task.
 void renameRepositoryEntry(RepositoryEntry entry, String nname, Principal user)
          Rename a repository entry.
 void resetReplet(Object repletId)
          Reset replet to initial state.
 void saveInArchive(Object repletId, String path, int format, Permission permission, ArchiveRule rule, String comment)
          Save a replet instance in the report archive.
 void setPermission(Principal principal, String resource, Permission permission)
          Set a user's permission of a specific access to a resource.
 void setScheduleTask(Principal principal, String name, ScheduleTask task)
          Save a schedule task.
 

Field Detail

REPLET

static final int REPLET
Create a standard replet.

See Also:
Constant Field Values

REPORT

static final int REPORT
Create a replet for use in the adhoc editing mode.

See Also:
createReplet(java.lang.Object, java.security.Principal, int), Constant Field Values

PREGENERATE

static final int PREGENERATE
Create a replet for pre-generation of report output (both bursting and regular reports) only. The replet can not be used to viewing directly by a user.

See Also:
createReplet(java.lang.Object, java.security.Principal, int), Constant Field Values

NOT_CHECK_PERMISSION

static final int NOT_CHECK_PERMISSION
Flag indicating this report doesn't need to check permission.

See Also:
Constant Field Values

AUTO_REPLET

static final int AUTO_REPLET
Flag indicating this report is we auto created report, not created by user.

See Also:
Constant Field Values

REPLET_MASK

static final int REPLET_MASK
Flag to filter out other hints, then only replet type left.

See Also:
Constant Field Values

NO_ARCHIVE

static final int NO_ARCHIVE
No archive is supported.

See Also:
Constant Field Values

DEFAULT_ARCHIVE

static final int DEFAULT_ARCHIVE
The default (file-based) archive type is supported.

See Also:
Constant Field Values

VERSIONED_ARCHIVE

static final int VERSIONED_ARCHIVE
The version-controlled archive type is supported.

See Also:
Constant Field Values

ADDTOQ_FAILURE

static final int ADDTOQ_FAILURE
The task of add to queue is failure.

See Also:
Constant Field Values

ADDTOQ_GENERATION

static final int ADDTOQ_GENERATION
The task of add to queue is failed,because page is generated.

See Also:
Constant Field Values

ADDTOQ_SUCCESS

static final int ADDTOQ_SUCCESS
The task of add to queue is success.

See Also:
Constant Field Values

PRINCIPAL_COOKIE

static final String PRINCIPAL_COOKIE
HTTP session key for the user principal.

See Also:
Constant Field Values

VIRTUAL_REPLET

static final String VIRTUAL_REPLET
Virtual replet.

See Also:
Constant Field Values
Method Detail

getProperty

String getProperty(String name)
                   throws RemoteException
Get the value of a specified property.

Parameters:
name - the name of the property.
Returns:
the value of the property, or null if the property is not defined.
Throws:
RemoteException - if an error occurs.

getFolders

RepositoryEntry[] getFolders(Principal principal,
                             String permission)
                             throws RemoteException
Get the list of all folders.

Parameters:
principal - a Principal object identifying the user that is requesting the folder list.
permission - the permissions the user must have on a folder in order for it to be returned. Should be a combination of 'r', 'w', and 'd', which stand for read, write, and delete respectively. If this parameter is null, all folders that the user has any permission on are returned.
Returns:
a list of RepositoryEntry objects that represent the folders that are registered.
Throws:
RemoteException - if an error occurs while getting the folder list.

getReplets

RepositoryEntry[] getReplets(Principal principal,
                             String permission)
                             throws RemoteException
Get the list of all replets.

Parameters:
principal - a Principal object identifying the user that is requesting the replet list.
permission - the permissions the user must have on a replet in order for it to be returned. Should be a combination of 'r', 'w', and 'd', which stand for read, write, and delete respectively. If this parameter is null, all replets that the user has any permission on are returned.
Returns:
a list of RepositoryEntry objects that represent the replets that are registered.
Throws:
RemoteException - if an error occurs while getting the replet list.

createReplet

Object createReplet(Object name,
                    Principal principal,
                    int type)
                    throws SRSecurityException,
                           RepletException,
                           RemoteException
Create an instance of the specified replet.

Parameters:
name - the name of the replet to create.
principal - a Principal object identifying the user requesting that the replet be created.
type - the type of replet being created.
Returns:
the replet instance ID.
Throws:
SRSecurityException - if the user does not have permission to view the report.
RepletException - if the replet could not be created.
RemoteException - if an unspecified error occurs.

generateReplet

void generateReplet(Object repletId,
                    RepletRequest request)
                    throws RepletException,
                           RemoteException
Generate a report from the specified replet instance. The createReplet method must be called before calling this method.

Parameters:
repletId - the replet instance ID returned from createReplet.
request - a RepletRequest object containing the report parameters. If this argument is null, the report is generated using the last request.
Throws:
RepletException - if an error occurs that prevents the report from being generated.
RemoteException - if some unspecified error occurs during generation.

destroy

void destroy(Object repletId,
             int type)
             throws RemoteException
Destroy a replet instance. If the specified replet is in the process of generating pages, it is interrupted.

Parameters:
repletId - the replet instance ID.
type - the creation type of the replet to destroy.
Throws:
RemoteException - if an error occurs while destroying the replet.

cancel

void cancel(Object repletId)
            throws RemoteException
Cancel a replet execution.

Parameters:
repletId - the replet instance ID.
Throws:
RemoteException - if an error occurs while destroying the replet.

getRepletParameters

RepletParameters getRepletParameters(Object repletId,
                                     String request)
                                     throws RemoteException
Get the report parameters for a specified replet. This may be used by the viewer to prompt the user for the parameter values.

Parameters:
repletId - the replet instance ID.
request - the name of the request.
Throws:
RemoteException - if an error occurs.

getRepletContext

RepletContext getRepletContext(Object repletId)
                               throws RemoteException
Get contextual information about a specfic replet.

Parameters:
repletId - the replet instance ID.
Returns:
the requested RepletContext object.
Throws:
RemoteException - if an error occurs.

getEventMask

int getEventMask(Object repletId)
                 throws RemoteException
Return the bitwise OR of all event flags for the events that this replet wants to receive.

Parameters:
repletId - replet instance ID.
Returns:
the event mask.
Throws:
RemoteException - if an error occurs.

getEventHandler

EventHandler getEventHandler(Object repletId)
                             throws RemoteException
Get the client-side command event handler for the specified replet. Client-side commands are handled completely by the client, without any involvement of the server.

Parameters:
repletId - the replet instance ID.
Returns:
the client-side command event handler.
Throws:
RemoteException - if an error occurs.

handleEvent

RepletCommand handleEvent(Object repletId,
                          EventObject event)
                          throws RemoteException
Handle a viewer event on the report server.

Parameters:
repletId - the instance ID of the replet that fired the event.
event - the viewer event.
Returns:
a command that should be executed in response to the event.
Throws:
RemoteException - if an error occurs.

getRegisteredSelections

SelectionEvent[] getRegisteredSelections(Object repletId)
                                         throws RemoteException
Get the selection events that are registerd with a specific replet.

Parameters:
repletId - the replet instance ID.
Returns:
the registered selection events.
Throws:
RemoteException - if an error occurs.

getHeadingTargets

HeadingTarget[] getHeadingTargets(Object repletId)
                                  throws RemoteException
Get the targets pointing to heading elements. These are used to construct a table of contents.

Parameters:
repletId - the replet instance ID.
Returns:
a list of all the heading targets in the specified replet.
Throws:
RemoteException - if an error occurs.

getPage

StylePage getPage(Object repletId,
                  int page)
                  throws RemoteException
Get a single page of a report. If the specified page is not yet available, this method waits for the page to be generated.

Parameters:
repletId - the replet instance ID.
page - the zero-based index of the page to get.
Returns:
a StylePage object for the requested page or null if the page does not exist.
Throws:
RemoteException - if an error occurs while getting the page.

getPageCount

int getPageCount(Object repletId)
                 throws RemoteException
Get the number of pages in a report.

Parameters:
repletId - the replet instance ID.
Returns:
the number of pages in the report.
Throws:
RemoteException - if an error occurs.

export

Object export(Object repletId,
              int format)
              throws RepletException,
                     RemoteException
Export a replet to the specified format. The exported file is cached internally. The cached file can be retrieved by calling the nextBlock method with the returned resource ID.

Parameters:
repletId - the instance ID of the replet to export.
format - the file format in which to export the replet. This must be one of the file format constants defined in inetsoft.report.io.Builder.
Returns:
the resource ID of the exported file.
Throws:
RepletException - if the replet could not be exported.
RemoteException - if an unspecified error occurs.

getResourceLength

long getResourceLength(Object resourceId)
                       throws RepletException,
                              RemoteException
Get the size, in bytes, of the specified resource.

Parameters:
resourceId - the ID of the resource, as returned by the export method.
Returns:
the size of the resource.
Throws:
RepletException - if the specified resource does not exist.
RemoteException - if an unspecified error occurs.

nextBlock

byte[] nextBlock(Object resourceId)
                 throws RepletException,
                        RemoteException
Get the next block of data in a specified resource.

Parameters:
resourceId - the ID of the resource, as returned by the export method.
Returns:
the next block of bytes, or null if no more data is available.
Throws:
RepletException - if the specified resource does not exist.
RemoteException - if an unspecified error occurs.

find

PageLocation find(Object repletId,
                  SearchCondition cond,
                  PageLocation start)
                  throws RemoteException
Search a replet to find the location in the report that meets the specified search criteria.

Parameters:
repletId - the instance ID of the replet to search.
cond - the search criteria.
start - the PageLocation of the element after which to start the search, or null to search from the beginning of the report.
Returns:
the location of the first element to meet the search criteria, or null if the search criteria could not be met.
Throws:
RemoteException - if an error occurs.

getPageLocation

PageLocation getPageLocation(Object repletId,
                             String elementId,
                             Point item)
                             throws RemoteException
Get the location of a specific element in a report.

Parameters:
repletId - the replet instance ID.
elementId - the unique ID of the report element.
item - the coordinates of the table cell, or null if the element is not a table.
Throws:
RemoteException - if an error occurs.

getPrinters

String[] getPrinters()
                     throws RemoteException
Get the names of all printers available to the server.

Returns:
the list of all available printers.
Throws:
RemoteException - if an error occurs.

print

void print(Object repletId,
           String printer,
           int[] pageList)
           throws RepletException,
                  RemoteException
Print a range of pages of a replet to the specified server printer.

Parameters:
repletId - the instance ID of the replet to print.
printer - the name of the printer on which to print the replet.
pageList - the indexes of the pages to print. If this parameter is null, all pages will be printed.
Throws:
RepletException - if the replet could not be printed.
RemoteException - if an unspecified error occurs.

mailTo

void mailTo(Object repletId,
            String recipients,
            String ccAddress,
            String bccAddress,
            String from,
            String subject,
            String msg,
            String fmt)
            throws RepletException,
                   RemoteException
Send a replet via email which includes "CC" and "BCC" addresses.

Parameters:
repletId - the instance ID of the replet to send.
recipients - the email address(es) of the recipients of the email message.
ccAddress - the "CC" email address(es) of the recipients.
bccAddress - the "BCC" email address(es) of the recipients.
from - the from text of the email header.
subject - the subject line of the email message.
msg - the body text of the email message.
fmt - the file format in which to send the report. Allowed values are the file format constants defined in inetsoft.report.io.Builder and "PDF".
Throws:
RepletException - if an error occurs while generating or sending the report.
RemoteException - if an unspecified error occurs.

mailTo

void mailTo(Object repletId,
            String recipients,
            String ccAddress,
            String bccAddress,
            String from,
            String subject,
            String msg,
            String fmt,
            boolean compress)
            throws RepletException,
                   RemoteException
Send a replet via email which includes "CC" and "BCC" addresses.

Parameters:
repletId - the instance ID of the replet to send.
recipients - the email address(es) of the recipients of the email message.
ccAddress - the "CC" email address(es) of the recipients.
bccAddress - the "BCC" email address(es) of the recipients.
from - the from text of the email header.
subject - the subject line of the email message.
msg - the body text of the email message.
fmt - the file format in which to send the report. Allowed values are the file format constants defined in inetsoft.report.io.Builder and "PDF".
compress - flag indicating whether or not the exported file is to be compressed.
Throws:
RepletException - if an error occurs while generating or sending the report.
RemoteException - if an unspecified error occurs.

mailTo

void mailTo(Object repletId,
            String recipients,
            String ccAddress,
            String bccAddress,
            String from,
            String subject,
            String msg,
            String fmt,
            boolean compress,
            String attachmentName)
            throws RepletException,
                   RemoteException
Send a replet via email which includes "CC" and "BCC" addresses.

Parameters:
repletId - the instance ID of the replet to send.
recipients - the email address(es) of the recipients of the email message.
ccAddress - the "CC" email address(es) of the recipients.
bccAddress - the "BCC" email address(es) of the recipients.
from - the from text of the email header.
subject - the subject line of the email message.
msg - the body text of the email message.
fmt - the file format in which to send the report. Allowed values are the file format constants defined in inetsoft.report.io.Builder and "PDF".
compress - flag indicating whether or not the exported
attachmentName - the email attachment's name. file is to be compressed.
Throws:
RepletException - if an error occurs while generating or sending the report.
RemoteException - if an unspecified error occurs.

mailTo

void mailTo(Object repletId,
            String recipients,
            String ccAddress,
            String bccAddress,
            String from,
            String subject,
            String msg,
            String fmt,
            boolean compress,
            String attachmentName,
            String password)
            throws RepletException,
                   RemoteException
Send a replet via email which includes "CC" and "BCC" addresses.

Parameters:
repletId - the instance ID of the replet to send.
recipients - the email address(es) of the recipients of the email message.
ccAddress - the "CC" email address(es) of the recipients.
bccAddress - the "BCC" email address(es) of the recipients.
from - the from text of the email header.
subject - the subject line of the email message.
msg - the body text of the email message.
fmt - the file format in which to send the report. Allowed values are the file format constants defined in inetsoft.report.io.Builder and "PDF".
compress - flag indicating whether or not the exported
attachmentName - the email attachment's name. file is to be compressed.
Throws:
RepletException - if an error occurs while generating or sending the report.
RemoteException - if an unspecified error occurs.

mailTo

void mailTo(Object repletId,
            String recipients,
            String ccAddress,
            String bccAddress,
            String from,
            String subject,
            String msg,
            String fmt,
            boolean compress,
            String attachmentName,
            String password,
            boolean htmlContent)
            throws RepletException,
                   RemoteException
Send a replet via email which includes "CC" and "BCC" addresses.

Throws:
RepletException
RemoteException

authenticate

Principal authenticate(ClientInfo user,
                       Object credential)
                       throws RemoteException
Authenticate a specific entity.

Parameters:
user - the client info of the user to be authenticated.
credential - some secure message that identifies the user, such as a user ID and password.
Returns:
a Principal object representing the specified user or null if the user could not be authenticated.
Throws:
RemoteException - if an error occurs while authenticating the user.

logout

void logout(Principal principal)
            throws RemoteException
Log the specified user out of the system.

Parameters:
principal - a Principal object identifying the user to be logged out.
Throws:
RemoteException - if an error occurs while logging out the user.

changePassword

void changePassword(Principal principal,
                    String password)
                    throws SRSecurityException,
                           RemoteException
Change the password of the specified user.

Parameters:
principal - a Principal object representing the user for whom to change the password.
password - the new password for the user.
Throws:
SRSecurityException - if the password could not be changed.
RemoteException - if an error occurs while changing the password.

checkPermission

boolean checkPermission(Principal principal,
                        String resource,
                        char access)
                        throws RemoteException
Check if a user has permission for the specified access to a resource.

Parameters:
principal - a Principal object representing the user for whom to check the permission.
resource - the name of the resource.
access - the access to check. r for read, w for write, and d for delete.
Throws:
RemoteException - if an error occurs while checking the permission.

containsFolder

boolean containsFolder(Principal principal,
                       String permission)
                       throws RemoteException
Check if a user could access folders.

Throws:
RemoteException

setPermission

void setPermission(Principal principal,
                   String resource,
                   Permission permission)
                   throws SRSecurityException,
                          RemoteException
Set a user's permission of a specific access to a resource.

Parameters:
principal - a Principal object identifying the user for whom to set the permission.
resource - the name of the resource.
permission - the permissions assigned to the user and resource.
Throws:
SRSecurityException - if the permissions could not be set.
RemoteException - if an error occurs while setting the permission.

getArchiveOption

int getArchiveOption()
                     throws RemoteException
Get the type of archive that is supported.

Returns:
NO_ARCHIVE, DEFAULT_ARCHIVE, or VERSIONED_ARCHIVE.
Throws:
RemoteException - if an error occurs.

getArchiveReport

Object getArchiveReport(String path,
                        String version,
                        Principal principal)
                        throws RepletException,
                               RemoteException
Open an archived report. This will either create a replet or open a file, the type of which (PDF, RTF, etc.) is determined by the file type stored in the archive.

Parameters:
path - the path to the archived report.
version - the version number of the report to retrieve. If the archive does not support versioning, this parameter is ignored and may be null.
principal - a Principal object identifying the user that is requesting the report.
Returns:
an export resource ID, prepended to a file extension, e.g. 389283.pdf.
Throws:
RepletException - if the resource could not be created.
RemoteException - if an unspecified error occurs.

saveInArchive

void saveInArchive(Object repletId,
                   String path,
                   int format,
                   Permission permission,
                   ArchiveRule rule,
                   String comment)
                   throws RepletException,
                          RemoteException
Save a replet instance in the report archive.

Parameters:
repletId - the replet instance ID.
path - the archive path to which to save the report.
format - the file format in which to save the report. This must be one of the file formats defined in inetsoft.report.io.Builder.
permission - the permission to be granted on the saved report.
rule - the archive rule for the saved report.
comment - a description of the saved report.
Throws:
RepletException - if the report could not be saved.
RemoteException - if an unspecified error occurs.

getRepositoryEntries

RepositoryEntry[] getRepositoryEntries(String folder,
                                       Principal user,
                                       String permission,
                                       int selector)
                                       throws RemoteException
Get available repository entries.

Parameters:
folder - the specified parent folder.
user - the specified user.
permission - the permissions the user must have on an entry in order for it to be returned. Should be a combination of 'r', 'w', and 'd', which stand for read, write, and delete respectively. If this parameter is null, all entries that the user has any permission on are returned.
selector - the specified selector, should be one of the repository entry type predefined in RepositoryEntry like FOLDER. The selector might be the combination of the types as well.
Throws:
RemoteException

isFolderChanged

boolean isFolderChanged(String folder,
                        Principal user)
                        throws RemoteException
Check if the tree change, response the refresh option to refresh the tree of portal page.

Throws:
RemoteException

changeFolder

void changeFolder(RepositoryEntry entry,
                  String folder,
                  Principal user)
                  throws RemoteException
Change folder of a repository entry.

Parameters:
entry - the specified repository entry.
folder - the specified new folder.
user - the specified user.
Throws:
RemoteException

addFolder

void addFolder(RepositoryEntry entry,
               String name,
               String alias,
               String description,
               Principal user)
               throws RemoteException
Add folder of a repository entry.

Parameters:
entry - the specified repository entry.
name - the name of new folder.
alias - the alias of new folder.
description - the description of new folder.
user - the specified user.
Throws:
RemoteException

removeRepositoryEntry

void removeRepositoryEntry(RepositoryEntry entry,
                           Principal user)
                           throws RemoteException
Remove a repostory entry.

Parameters:
entry - the specified repository entry.
user - the specified user.
Throws:
RemoteException

renameRepositoryEntry

void renameRepositoryEntry(RepositoryEntry entry,
                           String nname,
                           Principal user)
                           throws RemoteException
Rename a repository entry.

Parameters:
entry - the specified entry.
nname - the specified new name.
user - the specified user.
Throws:
RemoteException

getScheduleTasks

String[] getScheduleTasks(Principal principal)
                          throws IOException,
                                 RemoteException
Get a list of schedule tasks available to the specified user.

Parameters:
principal - a Principal object identifying the user making the request.
Returns:
a list of task names.
Throws:
IOException - if the user does not have permission to schedule tasks or a general I/O error occurs.
RemoteException - if an error occurs.

getScheduleTask

ScheduleTask getScheduleTask(String name)
                             throws RemoteException
Get the schedule task with the specified name.

Parameters:
name - the name of the schedule task.
Returns:
the requested ScheduleTask object.
Throws:
RemoteException - if an error occurs.

setScheduleTask

void setScheduleTask(Principal principal,
                     String name,
                     ScheduleTask task)
                     throws Exception
Save a schedule task.

Parameters:
principal - a Principal object identifying the user that is saving the task.
name - the name of the saved task.
task - the ScheduleTask object to save.
Throws:
IOException - if the specified user does not have permission to schedule tasks.
RemoteException - if an unspecified error occurs.
Exception

removeScheduleTask

void removeScheduleTask(Principal principal,
                        String name)
                        throws Exception
Remove a scheduled task.

Parameters:
principal - a Principal object identifying the user that is removing the task.
name - the name of the task to remove.
Throws:
IOException - if the specified user does not have permission to schedule tasks.
RemoteException - if an unspecified error occurs.
Exception

getPrintPages

Vector getPrintPages(Object repletId,
                     int[] printPages,
                     int fmt)
                     throws RemoteException
Get the corresponding pages of specified replet for print.

Parameters:
repletId - - Id of replet.
printPages - - selected pages to print. Null to print all pages.
fmt - the file format of the output as defined in Builder.
Throws:
RemoteException

getSingleStylePage

Enumeration getSingleStylePage(Object repletId)
                               throws RemoteException
Get a single style page of the specified replet. The generation will discard any page break, page header or page footer.

Parameters:
repletId - the replet id
Returns:
an enumeration stores the single style page
Throws:
RemoteException - if an unspecified error occurs.

isParameterSheet

boolean isParameterSheet(Object repletId)
                         throws RemoteException
Check if current report sheet is a parameter sheet.

Parameters:
repletId - the specified replet id.
Returns:
true if is a parameter sheet, false otherwise.
Throws:
RemoteException

containsParameterSheet

boolean containsParameterSheet(Object repletId)
                               throws RemoteException
Check if the replet contains parameter sheets.

Parameters:
repletId - the specified replet id.
Returns:
true if contains parameter sheets, false otherwise.
Throws:
RemoteException

disableParameterSheet

void disableParameterSheet(Object repletId)
                           throws RemoteException
Disable parameter sheets contained in the replet, and all the parameter sheets will be ignored when process replet.

Parameters:
repletId - the specified replet id.
Throws:
RemoteException

resetReplet

void resetReplet(Object repletId)
                 throws RemoteException
Reset replet to initial state. If contains parameter sheets, the first parameter sheet will be set to be current report sheet.

Parameters:
repletId - the specified replet id.
Throws:
RemoteException

addToQueue

int addToQueue(Object repletId,
               String replet,
               Principal user)
               throws RemoteException
Add a replet to queue when loading.

Parameters:
repletId - the specified replet id.
replet - the specified replet name.
user - the specified user.
Returns:
the result of add to queue, one of ADDTOQ_SUCCESS, ADDTOQ_GENERATION, and ADDTOQ_FAILURE.
Throws:
RemoteException

removeFromQueue

boolean removeFromQueue(Object repletId,
                        Principal user)
                        throws RemoteException
Remove a replet from queue.

Parameters:
repletId - the specified replet id.
user - the specified user.
Returns:
true if successfully removed from the report queue, false otherwise.
Throws:
RemoteException

getQueuedReplets

inetsoft.sree.internal.QueuedRepletInfo[] getQueuedReplets(Principal user)
                                                           throws RemoteException
Get replets information in the report queue.

Parameters:
user - the specified user.
Returns:
queued replet information.
Throws:
RemoteException

getActiveReplets

Object[] getActiveReplets(String user)
                          throws RemoteException
Get active replet ids.

Parameters:
user - the specified user. Pass null to include all replets.
Returns:
active replet ids.
Throws:
RemoteException

getArchiveReplets

Object[] getArchiveReplets(Principal user)
                           throws RemoteException
Get archive replets by principal.

Parameters:
user - the specified principal. Pass null to include all replets.
Returns:
archive replets ids.
Throws:
RemoteException

getReportSize

Size getReportSize(String name,
                   String version,
                   Principal user)
                   throws RemoteException
Gets the size of a report.

Parameters:
name - the name of the report.
version - the version of the report.
user - the user for whom the request is being made.
Returns:
the size of the report.
Throws:
RemoteException

createThumbnail

Image createThumbnail(String name,
                      String version,
                      Principal user)
                      throws RemoteException
Creates a thumbnail image for a report.

Parameters:
name - the name of the report.
version - the version of the report.
user - the user for whom the request is being made.
Returns:
a thumbnail image.
Throws:
RemoteException

getProcessStatus

int getProcessStatus(Object id)
                     throws RemoteException
Get the process status of a report.

Parameters:
id - the specified report id.
Throws:
RemoteException

getReportProperty

String getReportProperty(Object rid,
                         Object key)
                         throws RemoteException
Get report property.

Throws:
RemoteException

Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.