oracle.owb.report
Interface Report

All Superinterfaces:

Component, Extensible, OWBNamedObject, PropertyOwner, Snapshotable, ValidatableObject

public interface Report

extends Component, Extensible, ValidatableObject

A Report is a component of a Report Module that represents the structure of an individual report or worksheet.

Field Summary

static java.lang.String	CROSSTAB CROSSTAB indicates that the report type for the report is a crosstab.
static java.lang.String	OLAP OLAP indicates that the access type for the report is OLAP.
static java.lang.String	RELATIONAL RELATIONAL indicates that the access type for the report is relational.
static java.lang.String	TABLE TABLE indicates that the report type for the report is a table.

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

MAX_DEPENDENCY_DEPTH, MIN_DEPENDENCY_DEPTH

Method Summary

ReportItem	createReportItem(java.lang.String name) Creates a report item as the last report item of this report.
ReportItem	createReportItem(java.lang.String name, int position) Creates a report item at the specified position.
ReportItem	findReportItem(java.lang.String name) Search for a report item by name in this report.
java.lang.String	getAccessType() Returns the type of access to the data.
java.lang.String	getPrefix() Returns the prefix for component items.
ReportGroupShortcut[]	getReportGroupShortcuts() Returns a list of Report Group Shortcuts that reference this report.
ReportItem[]	getReportItems() Returns an ordered list of the report items of this report.
ReportModule	getReportModule() Returns the Report Module this report belongs to.
java.lang.String	getReportType() Returns the report type for the report.
OWBNamedObject[]	getSourceObjects() Gets a list of source objects that the Report depends on.
java.lang.String	getTitle() Returns the title for the report.
void	moveReportItem(ReportItem reportItem, int newPosition) Moves a report item to a new position.
void	setAccessType(java.lang.String accessType) Sets the type of access to the data.
void	setPrefix(java.lang.String prefix) Sets the prefix for component items.
void	setReportType(java.lang.String reportType) Sets the report type.
void	setTitle(java.lang.String title) Sets the title for the report.

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

Field Detail

CROSSTAB

public static final java.lang.String CROSSTAB

CROSSTAB indicates that the report type for the report is a crosstab.

See Also:

Constant Field Values

TABLE

public static final java.lang.String TABLE

TABLE indicates that the report type for the report is a table.

See Also:

Constant Field Values

RELATIONAL

public static final java.lang.String RELATIONAL

RELATIONAL indicates that the access type for the report is relational.

See Also:

Constant Field Values

OLAP

public static final java.lang.String OLAP

OLAP indicates that the access type for the report is OLAP.

See Also:

Constant Field Values

Method Detail

getReportType

public java.lang.String getReportType()

Returns the report type for the report.

Returns:

a String representing the report type. Values are CROSSTAB, TABLE or various graph types.

See Also:

setReportType(java.lang.String)

setReportType

public void setReportType(java.lang.String reportType)

Sets the report type.

Parameters:

reportType - a String specifying the report type. Values are CROSSTAB, TABLE or various graph types.

See Also:

getReportType()

getAccessType

public java.lang.String getAccessType()

Returns the type of access to the data.

Returns:

a String representing the access type. Values are RELATIONAL or OLAP.

See Also:

setAccessType(java.lang.String)

setAccessType

public void setAccessType(java.lang.String accessType)

Sets the type of access to the data.

Parameters:

accessType - a String specifying the access type. Values are RELATIONAL or OLAP.

See Also:

getAccessType()

getTitle

public java.lang.String getTitle()

Returns the title for the report.

Returns:

a String containing the title.

See Also:

setTitle(java.lang.String)

setTitle

public void setTitle(java.lang.String title)

Sets the title for the report.

Parameters:

title - a String specifying the title.

See Also:

getTitle()

getPrefix

public java.lang.String getPrefix()

Returns the prefix for component items.

Returns:

a String containing the prefix.

See Also:

setPrefix(java.lang.String)

setPrefix

public void setPrefix(java.lang.String prefix)

Sets the prefix for component items.

Parameters:

prefix - a String specifying the prefix.

See Also:

getPrefix()

getReportModule

public ReportModule getReportModule()

Returns the Report Module this report belongs to.

Returns:

a ReportModule object representing the owning report module.

getReportItems

public ReportItem[] getReportItems()

Returns an ordered list of the report items of this report.

Returns:

an array of ReportItems in position order.

createReportItem

public ReportItem createReportItem(java.lang.String name,
                                   int position)
                            throws NameSpaceException,
InvalidFormatException

Creates a report item at the specified position. Valid positions start with 1 (insert at the beginning) and end with the previous number of report items plus 1 (insert at the end).

Parameters:

name - the name for the new report item

position - the position the report item should be placed at

Returns:

the newly created ReportItem

Throws:

NameSpaceException

InvalidFormatException

createReportItem

public ReportItem createReportItem(java.lang.String name)
                            throws NameSpaceException,
InvalidFormatException

Creates a report item as the last report item of this report.

Parameters:

name - the name for the new report item

Returns:

the newly created ReportItem

Throws:

NameSpaceException

InvalidFormatException

findReportItem

public ReportItem findReportItem(java.lang.String name)

Search for a report item by name in this report.

Parameters:

name - the name of the report item to be found

Returns:

the ReportItem object if found, null otherwise

moveReportItem

public void moveReportItem(ReportItem reportItem,
                           int newPosition)

Moves a report item to a new position.

Parameters:

reportItem - the ReportItem to be moved

newPosition - the new position for the report item

getReportGroupShortcuts

public ReportGroupShortcut[] getReportGroupShortcuts()

Returns a list of Report Group Shortcuts that reference this report.

Returns:

an array of ReportGroupShortcuts

getSourceObjects

public OWBNamedObject[] getSourceObjects()

Gets a list of source objects that the Report depends on.

Returns:

an array of objects. (These objects may be of type Table, View, Dimension, Cube or Query Object)