ibi.broker.api.data.schedule
Class StorageMre

java.lang.Object
  extended by ibi.broker.api.data.schedule.Distribution
      extended by ibi.broker.api.data.schedule.StorageMre
All Implemented Interfaces:
java.io.Serializable

public class StorageMre
extends Distribution

 
   Managed Reporting storage is one of five distribution types supported by ReportCaster.
 The StorageMRE class extends the abstract Distribution class and is used when the 
 intended distribution method for the scheduled ReportCaster job is to store the output using
 Managed Reporting.

 The code below illustrates the use of the StorageMre class:

 + ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 +  Copyright (c) 2004 Information Builders, Inc. All  Rights Reserved.     +
 +                                                                          +
 +  Information Builders offers sample API programs as a heuristic device.  +
 +  They are not intended, as is, for production use. Licensed users are    +
 +  welcome to alter and extend these samples and deploy them in other      +
 +  environments, or alternate configurations, as they see fit.             +
 +  Information Builders will support the documented functionality of       +
 +  its API classes and methods. However, Information Builders is not       +
 +  responsible for functionality or behavior of products built with        +
 +  its API unless the documented behavior of its discrete classes and      +
 +  methods is different than the actual results.                           +
 +                                                                          +
 +  Redistributions of IBI source code and documentation must be within     +
 +  the scope of the Information Builders Software License Agreement.       +
 +                                                                          +
 + ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++   

    Distribution distribution = new StorageMre();
    distribution.setFolderName("TestFolder");
                schedule.setDistribution(distribution);
 

See Also:
Serialized Form

Field Summary
 
Fields inherited from class ibi.broker.api.data.schedule.Distribution
description, EMAIL, enabled, FTP, id, LIBRARY, MRE, PRINT, SFTP
 
Constructor Summary
StorageMre()
           
 
Method Summary
 java.lang.String getFolderName()
          Obtains the name of the folder to which you are sending a report for scheduled distribution to Managed Reporting.
 boolean isSameFolder()
           
 void setFolderName(java.lang.String folderName)
          Assigns the name of the folder to which you are sending a report for scheduled distribution to Managed Reporting.
 void setSameFolder(boolean sameFolder)
           
 
Methods inherited from class ibi.broker.api.data.schedule.Distribution
getDescription, getId, isEnabled, setDescription, setEnabled, setId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StorageMre

public StorageMre()
Method Detail

getFolderName

public java.lang.String getFolderName()
Obtains the name of the folder to which you are sending a report for scheduled distribution to Managed Reporting. The folder name will be appended next to the run time of the report and the name of the resulting report in the folder will also contain the folder name. The report will be placed in the domain of the report that it ran. If the report that was run is a Standard Report it will place it in that folder, if the report is a My Report it will be placed there.

Returns:
The folder name as a String.
See Also:
setFolderName(String)

setFolderName

public void setFolderName(java.lang.String folderName)
Assigns the name of the folder to which you are sending a report for scheduled distribution to Managed Reporting. The folder name will be appended next to the run time of the report and the name of the resulting report in the folder will also contain the folder name. The report will be placed in the domain of the report that it ran. If the report that was run is a Standard Report it will place it in that folder, if the report is a My Report it will be placed there.

Parameters:
folderName - The folder name as a String.
See Also:
getFolderName()

isSameFolder

public boolean isSameFolder()

setSameFolder

public void setSameFolder(boolean sameFolder)


Copyright © 2006 Information Builders, Incorporated.