oracle.jbo
Interface ViewObject

All Known Implementing Classes:

ViewObjectImpl

public interface ViewObject

extends StructureDef, RowSet, ComponentObject

Defines the presentation of the Entity Objects selected by an an SQL statement.

Since:

JDeveloper 3.0

Fields inherited from interface oracle.jbo.RowIterator

SLOT_BEFORE_FIRST, SLOT_BEYOND_LAST, SLOT_DELETED, SLOT_VALID

Method Summary

AttributeDef	addDynamicAttribute(java.lang.String attrName) Adds a dynamic attribute to the View Object's row set.
void	applyViewCriteria(ViewCriteria criteria) Applies the view criteria to this View Object.
RowSet	createRowSet(java.lang.String name) Creates and names a row set for the View Object.
ViewCriteria	createViewCriteria() Creates a "Query by Example" view criteria object.
AttributeDef	findViewLinkAccessor(ViewLink vl) Finds the view link accessor attribute.
java.lang.String	getOrderByClause() Retrieves the current ORDER BY clause of the View Object's query statement.
java.lang.String	getQuery() Retrieves the View Object's query statement.
ViewCriteria	getViewCriteria() Gets this View Object's view criteria.
java.lang.String[]	getViewLinkNames() Retrieves the names of the View Object's View Links.
java.lang.String	getWhereClause() Retrieves the current WHERE clause of the View Object's query statement.
boolean	isReadOnly() Tests if the View Object is read-only.
void	setOrderByClause(java.lang.String expr) Sets the ORDER BY clause of the View Object's query statement.
void	setWhereClause(java.lang.String cond) Sets the WHERE clause of the View Object's query statement.

Methods inherited from interface oracle.jbo.StructureDef

findAttributeDef, getAttributeCount, getAttributeDef, getAttributeDefs

Methods inherited from interface oracle.jbo.RowSet

createRowSetIterator, executeQuery, getApplicationModule, getEstimatedRowCount, getMasterRowSetIterators, getName, getViewObject, getWhereClauseParams, isAssociationConsistent, isForwardOnly, removeMasterRowSetIterator, setAssociationConsistent, setForwardOnly, setMasterRowSetIterator, setWhereClauseParam, setWhereClauseParams

Methods inherited from interface oracle.jbo.ComponentObject

getDefFullName, getDefName, getFullName, remove

Methods inherited from interface oracle.jbo.RowSetIterator

addListener, createDetailRowSet, getDetailRowSets, getRowSet, removeListener

Methods inherited from interface oracle.jbo.RowIterator

createRow, enumerateRowsInRange, findByEntity, findByKey, first, getAllRowsInRange, getCurrentRow, getCurrentRowIndex, getCurrentRowSlot, getFetchedRowCount, getRangeIndexOf, getRangeSize, getRangeStart, getRow, getRowAtRangeIndex, getRowCount, getRowCountInRange, hasNext, hasPrevious, insertRow, insertRowAtRangeIndex, isRangeAtBottom, isRangeAtTop, last, next, previous, removeCurrentRow, reset, scrollRange, scrollRangeTo, setCurrentRow, setCurrentRowAtRangeIndex, setRangeSize, setRangeStart

Method Detail

addDynamicAttribute

public AttributeDef addDynamicAttribute(java.lang.String attrName)

Adds a dynamic attribute to the View Object's row set.

Parameters:

attrName - the name of an attribute.

Returns:

the attribute's definition.

setWhereClause

public void setWhereClause(java.lang.String cond)

Sets the WHERE clause of the View Object's query statement.

Bind variables can be specified using '?' as a place-holder for the value.

Parameters:

cond - a WHERE clause, but excluding the 'WHERE' keyword.

getWhereClause

public java.lang.String getWhereClause()

Retrieves the current WHERE clause of the View Object's query statement.

Returns:

a WHERE clause, but excluding the 'WHERE' keyword.

setOrderByClause

public void setOrderByClause(java.lang.String expr)

Sets the ORDER BY clause of the View Object's query statement.

Bind variables can be specified using '?' as a place-holder for the value.

Parameters:

cond - a ORDER BY clause, but excluding the 'ORDER BY' keywords.

getOrderByClause

public java.lang.String getOrderByClause()

Retrieves the current ORDER BY clause of the View Object's query statement.

Returns:

a ORDER BY clause, but excluding the 'ORDER BY' keyword.

getQuery

public java.lang.String getQuery()

Retrieves the View Object's query statement.

Returns:

a SQL query statement.

isReadOnly

public boolean isReadOnly()

Tests if the View Object is read-only.

A view is read-only if it does not have Primary Keys or if all its entity references are reference-only.

Returns:

true if this is read-only.

createRowSet

public RowSet createRowSet(java.lang.String name)

Creates and names a row set for the View Object.

Parameters:

name - the name for the new RowSet.

getViewLinkNames

public java.lang.String[] getViewLinkNames()

Retrieves the names of the View Object's View Links.

Returns:

an array of names.

createViewCriteria

public ViewCriteria createViewCriteria()

Creates a "Query by Example" view criteria object.

Returns:

a view criteria object.

applyViewCriteria

public void applyViewCriteria(ViewCriteria criteria)

Applies the view criteria to this View Object.

View criteria rows are ORed together, while entries in the same row are ANDed together.

Parameters:

criteria - a view criteria object.

getViewCriteria

public ViewCriteria getViewCriteria()

Gets this View Object's view criteria.

Returns:

a view criteria object.

findViewLinkAccessor

public AttributeDef findViewLinkAccessor(ViewLink vl)

Finds the view link accessor attribute.

Parameters:

vl - the view link whose accessor is being sought.

Returns:

the attribute definition if one is found. null if not.