oracle.owb.report
Interface ReportModule

All Superinterfaces:

Component, Extensible, Folder, Module, OWBNamedObject, PropertyOwner, Snapshotable, ValidatableObject

public interface ReportModule

extends Module

A ReportModule is a specialized Module, which represents a collection of Report and Report Group definitions.

Fields inherited from interface oracle.owb.data.Module

MODULE_FLATFILE, MODULE_GATEWAY_DB2, MODULE_GATEWAY_DRDA, MODULE_GATEWAY_INFORMIX, MODULE_GATEWAY_ODBC, MODULE_GATEWAY_OTHER, MODULE_GATEWAY_RDB, MODULE_GATEWAY_SQLSERVER, MODULE_GATEWAY_SYBASE, MODULE_GATEWAY_TERRADATA, MODULE_ORACLE, MODULE_ORACLE_APPS, MODULE_PROCESS_FLOW, MODULE_SAP

Fields inherited from interface oracle.owb.metadatamgmt.changemgmt.Snapshotable

MAX_DEPENDENCY_DEPTH, MIN_DEPENDENCY_DEPTH

Method Summary

Report	createReport(java.lang.String name) Creates a Report definition with the supplied name.
ReportGroup	createReportGroup(java.lang.String name) Creates a Report Group with the supplied name.
Report	findReport(java.lang.String name) Finds a Report definition with the supplied name.
ReportGroup	findReportGroup(java.lang.String name) Finds a Report Group with the supplied name.
java.lang.String[]	getReportGroupNames() Returns the names of the Report Groups in the Report Module.
java.lang.String[]	getReportNames() Returns the names of the Reports in the Report Module.

Methods inherited from interface oracle.owb.data.Module

getDatatypeSet, getLocation, getProject, setLocation

Methods inherited from interface oracle.owb.foundation.Folder

findChild, getContentTypes, getFolderContents, getFolderContentsOfType, isCascadeForSnapshot, lockShared, lockWithContents, reloadWithContents, setCascadeForSnapshot

Methods inherited from interface oracle.owb.foundation.Component

getOwningFolder, isReloadNeeded, lock, reload, unlock

Methods inherited from interface oracle.owb.foundation.OWBNamedObject

delete, getBusinessName, getClassDefinition, getComponent, getDescription, getName, getUOID, isDeletable, isEditable, isRenamable, setBusinessName, setDescription, setName

Methods inherited from interface oracle.owb.metadatamgmt.changemgmt.Snapshotable

compare, compare, compare, compare, createSnapshot, createSnapshot, createSnapshotWithDependeeComponents, createSnapshotWithDependeeComponents, getSnapshots

Methods inherited from interface oracle.owb.compile.ValidatableObject

validate

Methods inherited from interface oracle.owb.foundation.property.PropertyOwner

getDefaultPropertyValue, getLogicalPropertyKeys, getPhysicalPropertyKeys, getPropertyDomain, getPropertyKeys, getPropertyValue, getPropertyValueString, isLogicalProperty, isPhysicalProperty, isReadOnlyProperty, setPropertyValue, setPropertyValueByString

Method Detail

getReportNames

public java.lang.String[] getReportNames()

Returns the names of the Reports in the Report Module.

Returns:

an array of Strings containing the names of the Reports.

createReport

public Report createReport(java.lang.String name)
                    throws NameSpaceException,
                           InvalidFormatException

Creates a Report definition with the supplied name.

Parameters:

name - a String containing the name for the new Report.

Returns:

a Report object representing the new report.

Throws:

NameSpaceException -

InvalidFormatException -

findReport

public Report findReport(java.lang.String name)

Finds a Report definition with the supplied name.

Parameters:

name - a String containing the name of the Report.

Returns:

the Report object, or null if not found.

getReportGroupNames

public java.lang.String[] getReportGroupNames()

Returns the names of the Report Groups in the Report Module.

Returns:

an array of Strings containing the names of the Report Groups.

createReportGroup

public ReportGroup createReportGroup(java.lang.String name)
                              throws NameSpaceException,
                                     InvalidFormatException

Creates a Report Group with the supplied name.

Parameters:

name - a String containing the name for the new Report Group.

Returns:

a Report Group object representing the new report group.

Throws:

NameSpaceException -

InvalidFormatException -

findReportGroup

public ReportGroup findReportGroup(java.lang.String name)

Finds a Report Group with the supplied name.

Parameters:

name - a String containing the name of the Report Group.

Returns:

the ReportGroup object, or null if not found.