// THIS SOFTWARE IS PROVIDED BY SOFTARIS PTY.LTD. AND OTHER METABOSS
// CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING,
// BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
// FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SOFTARIS PTY.LTD.
// OR OTHER METABOSS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
// OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
// EVEN IF SOFTARIS PTY.LTD. OR OTHER METABOSS CONTRIBUTORS ARE ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
// Copyright 2000-2005 Softaris Pty.Ltd. All Rights Reserved.
package com.metaboss.sdlctools.domains.enterprisemodel.storage;
import com.metaboss.enterprise.ps.PSException;
public interface PSReport
{
/** Naming URL of the component */
public static final String COMPONENT_URL = "component:/com.metaboss.sdlctools.domains.enterprisemodel.storage.PSReport";
/** Returns details corresponding to given reference or null struct if definition not found */
public STReport getReport(String pReportRef) throws PSException;
/** Returns number of output levels in the report. If one is returned
* it means that there is only one level - level zero in the report */
public int getReportOutputLevels(String pReportRef) throws PSException;
/** Returns report's input fields */
public STField[] getInputFields(String pReportRef) throws PSException;
/** Returns report's top level output fields */
public STField[] getOutputFields(String pReportRef, int pFromLevel) throws PSException;
/** Returns report's top level output entities */
public STReportEntity[] getOutputEntities(String pReportRef, int pFromLevel) throws PSException;
/** Returns attributes included in the report */
public String[] getOutputEntitiyAttributes(String pReportRef, int pFromLevel, String pOutputEntityName) throws PSException;
}
|