oracle.owb.report
Interface ReportGroup

All Superinterfaces:

Component, Extensible, OWBNamedObject, PropertyOwner, Snapshotable, ValidatableObject

public interface ReportGroup

extends Component, Extensible, ValidatableObject

A ReportGroup is a component of a Report Module that represents a named group of report definitions.

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

MAX_DEPENDENCY_DEPTH, MIN_DEPENDENCY_DEPTH

Method Summary

ReportGroupShortcut	createReportShortcut(Report report, java.lang.String name) Creates a shortcut to a Report.
ReportGroupShortcut	findShortcut(java.lang.String name) Search for a shortcut by name in this Report Group.
ReportModule	getReportModule() Returns the Report Module this report group belongs to.
ReportGroupShortcut[]	getReportShortcuts() Returns a list of the shortcuts to the Reports in this Report Group.

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.foundation.property.PropertyOwner

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

Methods inherited from interface oracle.owb.compile.ValidatableObject

validate

Method Detail

getReportModule

public ReportModule getReportModule()

Returns the Report Module this report group belongs to.

Returns:

a ReportModule object representing the owning report module.

getReportShortcuts

public ReportGroupShortcut[] getReportShortcuts()

Returns a list of the shortcuts to the Reports in this Report Group.

Returns:

an array of ReportGroupShortcuts

createReportShortcut

public ReportGroupShortcut createReportShortcut(Report report,
                                                java.lang.String name)
                                         throws NameSpaceException,
                                                InvalidFormatException

Creates a shortcut to a Report.

Parameters:

report - the Report which the shortcut is to reference

name - the name of the shortcut (if no name is supplied, a default name will be used)

Returns:

the newly created ReportGroupShortcut

Throws:

NameSpaceException -

InvalidFormatException -

findShortcut

public ReportGroupShortcut findShortcut(java.lang.String name)

Search for a shortcut by name in this Report Group.

Parameters:

name - the name of the Report Group Shortcut to be found

Returns:

the ReportGroupShortcut if found, null otherwise