|
Style Intelligence v12.0 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface RepletRepository
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 |
|---|
static final int REPLET
static final int REPORT
createReplet(java.lang.Object,
java.security.Principal, int),
Constant Field Valuesstatic final int PREGENERATE
createReplet(java.lang.Object,
java.security.Principal, int),
Constant Field Valuesstatic final int NOT_CHECK_PERMISSION
static final int AUTO_REPLET
static final int REPLET_MASK
static final int NO_ARCHIVE
static final int DEFAULT_ARCHIVE
static final int VERSIONED_ARCHIVE
static final int ADDTOQ_FAILURE
static final int ADDTOQ_GENERATION
static final int ADDTOQ_SUCCESS
static final String PRINCIPAL_COOKIE
static final String VIRTUAL_REPLET
| Method Detail |
|---|
String getProperty(String name)
throws RemoteException
name - the name of the property.
null if the property
is not defined.
RemoteException - if an error occurs.
RepositoryEntry[] getFolders(Principal principal,
String permission)
throws RemoteException
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.
RemoteException - if an error occurs while getting the folder list.
RepositoryEntry[] getReplets(Principal principal,
String permission)
throws RemoteException
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.
RemoteException - if an error occurs while getting the replet list.
Object createReplet(Object name,
Principal principal,
int type)
throws SRSecurityException,
RepletException,
RemoteException
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.
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.
void generateReplet(Object repletId,
RepletRequest request)
throws RepletException,
RemoteException
createReplet method must be called before calling this
method.
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.
RepletException - if an error occurs that prevents the report from
being generated.
RemoteException - if some unspecified error occurs during
generation.
void destroy(Object repletId,
int type)
throws RemoteException
repletId - the replet instance ID.type - the creation type of the replet to destroy.
RemoteException - if an error occurs while destroying the replet.
void cancel(Object repletId)
throws RemoteException
repletId - the replet instance ID.
RemoteException - if an error occurs while destroying the replet.
RepletParameters getRepletParameters(Object repletId,
String request)
throws RemoteException
repletId - the replet instance ID.request - the name of the request.
RemoteException - if an error occurs.
RepletContext getRepletContext(Object repletId)
throws RemoteException
repletId - the replet instance ID.
RemoteException - if an error occurs.
int getEventMask(Object repletId)
throws RemoteException
repletId - replet instance ID.
RemoteException - if an error occurs.
EventHandler getEventHandler(Object repletId)
throws RemoteException
repletId - the replet instance ID.
RemoteException - if an error occurs.
RepletCommand handleEvent(Object repletId,
EventObject event)
throws RemoteException
repletId - the instance ID of the replet that fired the event.event - the viewer event.
RemoteException - if an error occurs.
SelectionEvent[] getRegisteredSelections(Object repletId)
throws RemoteException
repletId - the replet instance ID.
RemoteException - if an error occurs.
HeadingTarget[] getHeadingTargets(Object repletId)
throws RemoteException
repletId - the replet instance ID.
RemoteException - if an error occurs.
StylePage getPage(Object repletId,
int page)
throws RemoteException
repletId - the replet instance ID.page - the zero-based index of the page to get.
null if
the page does not exist.
RemoteException - if an error occurs while getting the page.
int getPageCount(Object repletId)
throws RemoteException
repletId - the replet instance ID.
RemoteException - if an error occurs.
Object export(Object repletId,
int format)
throws RepletException,
RemoteException
nextBlock method with the returned resource ID.
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.
RepletException - if the replet could not be exported.
RemoteException - if an unspecified error occurs.
long getResourceLength(Object resourceId)
throws RepletException,
RemoteException
resourceId - the ID of the resource, as returned by the
export method.
RepletException - if the specified resource does not exist.
RemoteException - if an unspecified error occurs.
byte[] nextBlock(Object resourceId)
throws RepletException,
RemoteException
resourceId - the ID of the resource, as returned by the
export method.
null if no more data
is available.
RepletException - if the specified resource does not exist.
RemoteException - if an unspecified error occurs.
PageLocation find(Object repletId,
SearchCondition cond,
PageLocation start)
throws RemoteException
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.
null if the search criteria could not be met.
RemoteException - if an error occurs.
PageLocation getPageLocation(Object repletId,
String elementId,
Point item)
throws RemoteException
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.
RemoteException - if an error occurs.
String[] getPrinters()
throws RemoteException
RemoteException - if an error occurs.
void print(Object repletId,
String printer,
int[] pageList)
throws RepletException,
RemoteException
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.
RepletException - if the replet could not be printed.
RemoteException - if an unspecified error occurs.
void mailTo(Object repletId,
String recipients,
String ccAddress,
String bccAddress,
String from,
String subject,
String msg,
String fmt)
throws RepletException,
RemoteException
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".
RepletException - if an error occurs while generating or sending the
report.
RemoteException - if an unspecified error occurs.
void mailTo(Object repletId,
String recipients,
String ccAddress,
String bccAddress,
String from,
String subject,
String msg,
String fmt,
boolean compress)
throws RepletException,
RemoteException
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.
RepletException - if an error occurs while generating or sending the
report.
RemoteException - if an unspecified error occurs.
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
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 exportedattachmentName - the email attachment's name.
file is to be compressed.
RepletException - if an error occurs while generating or sending the
report.
RemoteException - if an unspecified error occurs.
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
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 exportedattachmentName - the email attachment's name.
file is to be compressed.
RepletException - if an error occurs while generating or sending the
report.
RemoteException - if an unspecified error occurs.
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
RepletException
RemoteException
Principal authenticate(ClientInfo user,
Object credential)
throws RemoteException
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.
null if the user could not be authenticated.
RemoteException - if an error occurs while authenticating the user.
void logout(Principal principal)
throws RemoteException
principal - a Principal object identifying the user to be logged out.
RemoteException - if an error occurs while logging out the user.
void changePassword(Principal principal,
String password)
throws SRSecurityException,
RemoteException
principal - a Principal object representing the user for whom to
change the password.password - the new password for the user.
SRSecurityException - if the password could not be changed.
RemoteException - if an error occurs while changing the password.
boolean checkPermission(Principal principal,
String resource,
char access)
throws RemoteException
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.
RemoteException - if an error occurs while checking the permission.
boolean containsFolder(Principal principal,
String permission)
throws RemoteException
RemoteException
void setPermission(Principal principal,
String resource,
Permission permission)
throws SRSecurityException,
RemoteException
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.
SRSecurityException - if the permissions could not be set.
RemoteException - if an error occurs while setting the permission.
int getArchiveOption()
throws RemoteException
NO_ARCHIVE, DEFAULT_ARCHIVE, or
VERSIONED_ARCHIVE.
RemoteException - if an error occurs.
Object getArchiveReport(String path,
String version,
Principal principal)
throws RepletException,
RemoteException
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.
RepletException - if the resource could not be created.
RemoteException - if an unspecified error occurs.
void saveInArchive(Object repletId,
String path,
int format,
Permission permission,
ArchiveRule rule,
String comment)
throws RepletException,
RemoteException
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.
RepletException - if the report could not be saved.
RemoteException - if an unspecified error occurs.
RepositoryEntry[] getRepositoryEntries(String folder,
Principal user,
String permission,
int selector)
throws RemoteException
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.
RemoteException
boolean isFolderChanged(String folder,
Principal user)
throws RemoteException
RemoteException
void changeFolder(RepositoryEntry entry,
String folder,
Principal user)
throws RemoteException
entry - the specified repository entry.folder - the specified new folder.user - the specified user.
RemoteException
void addFolder(RepositoryEntry entry,
String name,
String alias,
String description,
Principal user)
throws RemoteException
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.
RemoteException
void removeRepositoryEntry(RepositoryEntry entry,
Principal user)
throws RemoteException
entry - the specified repository entry.user - the specified user.
RemoteException
void renameRepositoryEntry(RepositoryEntry entry,
String nname,
Principal user)
throws RemoteException
entry - the specified entry.nname - the specified new name.user - the specified user.
RemoteException
String[] getScheduleTasks(Principal principal)
throws IOException,
RemoteException
principal - a Principal object identifying the user making the
request.
IOException - if the user does not have permission to schedule tasks
or a general I/O error occurs.
RemoteException - if an error occurs.
ScheduleTask getScheduleTask(String name)
throws RemoteException
name - the name of the schedule task.
RemoteException - if an error occurs.
void setScheduleTask(Principal principal,
String name,
ScheduleTask task)
throws Exception
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.
IOException - if the specified user does not have permission to
schedule tasks.
RemoteException - if an unspecified error occurs.
Exception
void removeScheduleTask(Principal principal,
String name)
throws Exception
principal - a Principal object identifying the user that is removing
the task.name - the name of the task to remove.
IOException - if the specified user does not have permission to
schedule tasks.
RemoteException - if an unspecified error occurs.
Exception
Vector getPrintPages(Object repletId,
int[] printPages,
int fmt)
throws RemoteException
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.
RemoteException
Enumeration getSingleStylePage(Object repletId)
throws RemoteException
repletId - the replet id
RemoteException - if an unspecified error occurs.
boolean isParameterSheet(Object repletId)
throws RemoteException
repletId - the specified replet id.
RemoteException
boolean containsParameterSheet(Object repletId)
throws RemoteException
repletId - the specified replet id.
RemoteException
void disableParameterSheet(Object repletId)
throws RemoteException
repletId - the specified replet id.
RemoteException
void resetReplet(Object repletId)
throws RemoteException
repletId - the specified replet id.
RemoteException
int addToQueue(Object repletId,
String replet,
Principal user)
throws RemoteException
repletId - the specified replet id.replet - the specified replet name.user - the specified user.
RemoteException
boolean removeFromQueue(Object repletId,
Principal user)
throws RemoteException
repletId - the specified replet id.user - the specified user.
true if successfully removed from the report queue,
false otherwise.
RemoteException
inetsoft.sree.internal.QueuedRepletInfo[] getQueuedReplets(Principal user)
throws RemoteException
user - the specified user.
RemoteException
Object[] getActiveReplets(String user)
throws RemoteException
user - the specified user. Pass null to include all replets.
RemoteException
Object[] getArchiveReplets(Principal user)
throws RemoteException
user - the specified principal. Pass null to include all replets.
RemoteException
Size getReportSize(String name,
String version,
Principal user)
throws RemoteException
name - the name of the report.version - the version of the report.user - the user for whom the request is being made.
RemoteException
Image createThumbnail(String name,
String version,
Principal user)
throws RemoteException
name - the name of the report.version - the version of the report.user - the user for whom the request is being made.
RemoteException
int getProcessStatus(Object id)
throws RemoteException
id - the specified report id.
RemoteException
String getReportProperty(Object rid,
Object key)
throws RemoteException
RemoteException
|
Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved. | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||