Edit D:\app\Administrator\product\11.2.0\dbhome_1\olap\api\doc\oracle\olapi\data\source\Template.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

<HTML>
<HEAD>

<TITLE>
Template (Oracle OLAP Java API Reference)
</TITLE>

<SCRIPT type="text/javascript">
function windowTitle()
{
 parent.document.title="Template (Oracle OLAP Java API Reference)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>

</HEAD>

<A NAME="navbar_top"></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 <TR ALIGN="center" VALIGN="top">
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html">Overview</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A>&nbsp;</TD>
 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;Class&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html">Tree</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html">Deprecated</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html">Index</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html">Help</A>&nbsp;</TD>
 </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3>
Oracle&reg; OLAP Java API Reference 11g Release 2 (11.2) E10794-01 Beta Draft
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2">
&nbsp;<A HREF="../../../../oracle/olapi/data/source/StringSource.html" title="class in oracle.olapi.data.source">PREV CLASS</A>&nbsp;
&nbsp;<A HREF="../../../../oracle/olapi/data/source/UnmatchedInputsException.html" title="class in oracle.olapi.data.source">NEXT CLASS</A></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2">
 <A HREF="../../../../index.html?oracle/olapi/data/source/Template.html" target="_top">FRAMES</A> &nbsp;
&nbsp;<A HREF="Template.html" target="_top">NO FRAMES</A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
 
</SCRIPT>
<NOSCRIPT>
 <A HREF="../../../../allclasses-noframe.html">All Classes</A>
</NOSCRIPT>

</TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3">
 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></TD>
<TD VALIGN="top" CLASS="NavBarCell3">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>

<HR>

<H2>

oracle.olapi.data.source
 
Class Template</H2>
<PRE>
java.lang.Object
 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">oracle.olapi.data.source.Template
</PRE>
<HR>
<DL>
<DT><PRE>public abstract class Template<DT>extends java.lang.Object</DL>
</PRE>

The basis for creating a <code>Source</code> that an application can
 dynamically change.
 An application can use a <code>Template</code> to take the selections
 made by an end user and produce a <code>Source</code> that represents
 a query on the data store, or a step in producing a query.

A <code>Template</code> uses the following related objects.
 <ul>
 <li><code>MetadataState</code>
 <li><code>DataProvider</code>
 <li><code>SourceGenerator</code>
 <li><code>DynamicDefinition</code>
 </ul>

Those objects work together as follows:
 <ul>
 <li>The <code>MetadataState</code> implementation for a <CODE>Template</CODE>
 has fields for storing values.
 <li>An application passes the <code>MetadataState</code> and the
 <CODE>DataProvider</CODE> to the <code>Template</code> constructor.
 The <code>Template</code> abstract class has methods that create a
 <code>DynamicDefinition</code> and that get and set the current
 state of the <code>MetadataState</code>.
 A class that extends <code>Template</code> adds methods that set the
 values of the fields of its <code>MetadataState</code>.
 <li>A <code>SourceGenerator</code> implementation has a
 <code>generateSource</code> method that uses the current state of
 the data in the <code>MetadataState</code> to produce a
 <code>Source</code>.
 <li>The <CODE>Template</CODE> gets a <code>DynamicDefinition</code>
 by passing a <code>SourceGenerator</code> to its 
 <CODE>createDynamicDefinition</CODE> method.
 <li>The <code>DynamicDefinition</code> has a <code>getSource</code>
 method that returns the <CODE>Source</CODE> produced by the
 <code>SourceGenerator</code>.
 That <CODE>Source</CODE> is the dynamic <CODE>Source</CODE> for the
 <CODE>Template</CODE>.
</ul>

In the process of producing a <code>Source</code> that represents a 
 single query, an application can use the <code>Source</code> objects produced 
 by various other <code>Template</code> implementations. 
 The application can change the selection of data for any one of the
 <code>Template</code> objects that comprise the query.
 Because the <code>DynamicDefinition</code> that gets the <code>Source</code>
 for a <code>Template</code> is a proxy, the application does not have to
 recreate all of the component <code>Source</code> objects to produce a
 <code>Source</code> for the query that includes the new selection.
 Instead, the application just calls the <code>getSource</code> method of the
 <code>DynamicDefinition</code> for the <code>Template</code> that produces
 the query, and the current state of the changed <code>Template</code>
 component is used in rebuilding the query.

An example of a <CODE>Template</CODE> that produces a query is the
 <CODE>TopBottomTemplate.java</CODE> class.
 In building the query, it uses the <CODE>Source</CODE> produced by the 
 <CODE>SingleSelectionTemplate.java</CODE> class.
 The <CODE>TopBottomTest.java</CODE> class is an example program that creates 
 a <CODE>SingleSelectionTemplate</CODE> and a <CODE>TopBottomTemplate.java</CODE>.
 For information on how to get the example classes, see 
 <a href="../../../../doc-files/ExamplePrograms.html">Example Oracle OLAP Java API Programs</a>.

A <CODE>SingleSelectionTemplate</CODE> object produces a <CODE>Source</CODE>
 that represents the values of a measure that are specified by a set of single
 members of all but one of the dimensions of the measure.
 A <CODE>TopBottomTemplate</CODE> adds the remaining dimension of the measure.
 It selects the elements of that dimension that are specified by the criteria 
 represented by the <CODE>Source</CODE> for the <CODE>SingleSelectionTemplate</CODE>.
 It sorts the selection in ascending or descending order and produces a
 <CODE>Source</CODE> that represents a specified number of elements from
 the sorted selection.

The <CODE>TopBottomTest.java</CODE> example program creates 
 a <CODE>SingleSelectionTemplate</CODE> and a <CODE>TopBottomTemplate.java</CODE>.
 The program produces a <CODE>Source</CODE> that specifies the ten products 
 that have the highest number of units sold for the set of single Time, Channel,
 and Customer dimension values.
 It prepares and commits the current <CODE>Transaction</CODE>.
 It then creates a <CODE>Cursor</CODE> for that <CODE>Source</CODE> and 
 displays the values of the <CODE>Cursor</CODE>.

The example classes <CODE>TopBottomTemplate.java</CODE> and 
 <CODE>SingleSelectionTemplate.java</CODE> contain inner classes that implement
 the <CODE>SourceGenerator</CODE> interface.
 The <CODE>TopBottomTemplate</CODE> produces a query and the 
 <CODE>SingleSelectionTemplate</CODE> produces a <CODE>Source</CODE> that the
 <CODE>TopBottomTemplate</CODE> uses in the process of building the query.

The program next changes the value for one of the dimensions specified
 by the <CODE>SingleSelectionTemplate</CODE>, and it changes the number of 
 elements to select and the type of the selection.
 It prepares and commits the current <CODE>Transaction</CODE>, creates
 a new <CODE>Cursor</CODE> for the <CODE>Source</CODE>, and displays
 the values of the <CODE>Cursor</CODE>.
 The values are now the five products that have the lowest number of units sold 
 for the set of the other dimension values.

Before creating the new <CODE>Cursor</CODE>, the program does not need to call
 the <code>getSource</code> method of the <CODE>DynamicDefinition</CODE> for
 either the <code>SingleSelectionTemplate</code> or the
 <CODE>TopBottomTemplate</CODE>.
 Committing the <CODE>Transaction</CODE> automatically updates the dynamic 
 <CODE>Source</CODE> objects that those methods returned so that those
 <CODE>Source</CODE> objects represent the current state of the 
 <CODE>Template</CODE> objects.

<DL>
<DT>See Also:<DD><A HREF="../../../../oracle/olapi/data/source/DynamicDefinition.html" title="class in oracle.olapi.data.source"><CODE>DynamicDefinition</CODE></A>, 
<A HREF="../../../../oracle/olapi/transaction/metadataStateManager/MetadataState.html" title="interface in oracle.olapi.transaction.metadataStateManager"><CODE>MetadataState</CODE></A>, 
<A HREF="../../../../oracle/olapi/data/source/SourceGenerator.html" title="interface in oracle.olapi.data.source"><CODE>SourceGenerator</CODE></A>, 
<A HREF="../../../../oracle/olapi/transaction/TransactionProvider.html" title="interface in oracle.olapi.transaction"><CODE>TransactionProvider</CODE></A></DL>
<HR>

<A NAME="constructor_summary"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2">
Constructor Summary</TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>protected </CODE></TD>
<TD><CODE><A HREF="../../../../oracle/olapi/data/source/Template.html#Template(oracle.olapi.transaction.metadataStateManager.MetadataState, oracle.olapi.data.source.DataProvider)">Template</A>(<A HREF="../../../../oracle/olapi/transaction/metadataStateManager/MetadataState.html" title="interface in oracle.olapi.transaction.metadataStateManager">MetadataState</A>&nbsp;initialState,
 <A HREF="../../../../oracle/olapi/data/source/DataProvider.html" title="class in oracle.olapi.data.source">DataProvider</A>&nbsp;dataProvider)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new <code>Template</code>.</TD>
</TR>
</TABLE>
&nbsp;

<A NAME="method_summary"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2">
Method Summary</TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>protected &nbsp;<A HREF="../../../../oracle/olapi/data/source/DynamicDefinition.html" title="class in oracle.olapi.data.source">DynamicDefinition</A></CODE></TD>
<TD><CODE><A HREF="../../../../oracle/olapi/data/source/Template.html#createDynamicDefinition(oracle.olapi.data.source.SourceGenerator)">createDynamicDefinition</A>(<A HREF="../../../../oracle/olapi/data/source/SourceGenerator.html" title="interface in oracle.olapi.data.source">SourceGenerator</A>&nbsp;sourceGenerator)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a <code>DynamicDefinition</code> that acts as a proxy for the
 <code>SourceDefinition</code> for the <code>Source</code>
 generated by the <code>SourceGenerator</code> and returned by the
 <CODE>getSource</CODE> method of the <code>DynamicDefinition</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>protected &nbsp;<A HREF="../../../../oracle/olapi/transaction/metadataStateManager/MetadataState.html" title="interface in oracle.olapi.transaction.metadataStateManager">MetadataState</A></CODE></TD>
<TD><CODE><A HREF="../../../../oracle/olapi/data/source/Template.html#getCurrentState()">getCurrentState</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the current state for this <code>Template</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>protected &nbsp;<A HREF="../../../../oracle/olapi/transaction/metadataStateManager/MetadataState.html" title="interface in oracle.olapi.transaction.metadataStateManager">MetadataState</A></CODE></TD>
<TD><CODE><A HREF="../../../../oracle/olapi/data/source/Template.html#getCurrentStateForRead()">getCurrentStateForRead</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the actual <CODE>MetadataState</CODE> object for this 
 <code>Template</code> rather than a clone of the state.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>protected &nbsp;<A HREF="../../../../oracle/olapi/transaction/metadataStateManager/MetadataState.html" title="interface in oracle.olapi.transaction.metadataStateManager">MetadataState</A></CODE></TD>
<TD><CODE><A HREF="../../../../oracle/olapi/data/source/Template.html#getCurrentStateForWrite()">getCurrentStateForWrite</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the current state for this <code>Template</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;<A HREF="../../../../oracle/olapi/data/source/DataProvider.html" title="class in oracle.olapi.data.source">DataProvider</A></CODE></TD>
<TD><CODE><A HREF="../../../../oracle/olapi/data/source/Template.html#getDataProvider()">getDataProvider</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the <CODE>DataProvider</CODE> for this <CODE>Template</CODE>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>protected &nbsp;void</CODE></TD>
<TD><CODE><A HREF="../../../../oracle/olapi/data/source/Template.html#setCurrentState(oracle.olapi.transaction.metadataStateManager.MetadataState)">setCurrentState</A>(<A HREF="../../../../oracle/olapi/transaction/metadataStateManager/MetadataState.html" title="interface in oracle.olapi.transaction.metadataStateManager">MetadataState</A>&nbsp;state)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Specifies a state as the current state for this <code>Template</code>.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left">Methods inherited from class java.lang.Object</TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;

<A NAME="constructor_detail"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1">
Constructor Detail</TH>
</TR>
</TABLE>

<A NAME="Template(oracle.olapi.transaction.metadataStateManager.MetadataState, oracle.olapi.data.source.DataProvider)"></A><H3>
Template</H3>
<PRE>
protected Template(<A HREF="../../../../oracle/olapi/transaction/metadataStateManager/MetadataState.html" title="interface in oracle.olapi.transaction.metadataStateManager">MetadataState</A>&nbsp;initialState,
 <A HREF="../../../../oracle/olapi/data/source/DataProvider.html" title="class in oracle.olapi.data.source">DataProvider</A>&nbsp;dataProvider)
 throws <A HREF="../../../../oracle/olapi/transaction/TransactionTypeUnavailableException.html" title="class in oracle.olapi.transaction">TransactionTypeUnavailableException</A>,
 <A HREF="../../../../oracle/olapi/transaction/TransactionInactiveException.html" title="class in oracle.olapi.transaction">TransactionInactiveException</A></PRE>
<DL>
<DD>Creates a new <code>Template</code>.

<DL>
<DT>Parameters:<DD><CODE>initialState</CODE> - The <code>MetadataState</code> that stores values 
 for this <code>Template</code>.<DD><CODE>dataProvider</CODE> - The <code>DataProvider</code> created using the current
 <code>TransactionProvider</code>.
<DT>Throws:
<DD><CODE><A HREF="../../../../oracle/olapi/transaction/TransactionInactiveException.html" title="class in oracle.olapi.transaction">TransactionInactiveException</A></CODE>
<DD><CODE><A HREF="../../../../oracle/olapi/transaction/TransactionTypeUnavailableException.html" title="class in oracle.olapi.transaction">TransactionTypeUnavailableException</A></CODE></DL>
</DL>

<A NAME="method_detail"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1">
Method Detail</TH>
</TR>
</TABLE>

<A NAME="createDynamicDefinition(oracle.olapi.data.source.SourceGenerator)"></A><H3>
createDynamicDefinition</H3>
<PRE>
protected <A HREF="../../../../oracle/olapi/data/source/DynamicDefinition.html" title="class in oracle.olapi.data.source">DynamicDefinition</A> createDynamicDefinition(<A HREF="../../../../oracle/olapi/data/source/SourceGenerator.html" title="interface in oracle.olapi.data.source">SourceGenerator</A>&nbsp;sourceGenerator)</PRE>
<DL>
<DD>Creates a <code>DynamicDefinition</code> that acts as a proxy for the
 <code>SourceDefinition</code> for the <code>Source</code>
 generated by the <code>SourceGenerator</code> and returned by the
 <CODE>getSource</CODE> method of the <code>DynamicDefinition</code>.

<DD><DL>
<DT>Parameters:<DD><CODE>sourceGenerator</CODE> - The <code>SourceGenerator</code> that generates
 a <code>Source</code> using the current
 state of this <code>Template</code>.
<DT>Returns:<DD>A <code>DynamicDefinition</code> that provides access to the
 <code>Source</code> produced by the <code>SourceGenerator</code>.</DL>
</DD>
</DL>
<HR>

<A NAME="getCurrentState()"></A><H3>
getCurrentState</H3>
<PRE>
protected <A HREF="../../../../oracle/olapi/transaction/metadataStateManager/MetadataState.html" title="interface in oracle.olapi.transaction.metadataStateManager">MetadataState</A> getCurrentState()
 throws <A HREF="../../../../oracle/olapi/transaction/TransactionalObjectInvalidException.html" title="class in oracle.olapi.transaction">TransactionalObjectInvalidException</A>,
 <A HREF="../../../../oracle/olapi/transaction/TransactionTypeUnavailableException.html" title="class in oracle.olapi.transaction">TransactionTypeUnavailableException</A>,
 <A HREF="../../../../oracle/olapi/transaction/TransactionInactiveException.html" title="class in oracle.olapi.transaction">TransactionInactiveException</A></PRE>
<DL>
<DD>Gets the current state for this <code>Template</code>.

<DD><DL>

<DT>Returns:<DD>The current state for this <code>Template</code>.
<DT>Throws:
<DD><CODE><A HREF="../../../../oracle/olapi/transaction/TransactionalObjectInvalidException.html" title="class in oracle.olapi.transaction">TransactionalObjectInvalidException</A></CODE>
<DD><CODE><A HREF="../../../../oracle/olapi/transaction/TransactionInactiveException.html" title="class in oracle.olapi.transaction">TransactionInactiveException</A></CODE>
<DD><CODE><A HREF="../../../../oracle/olapi/transaction/TransactionTypeUnavailableException.html" title="class in oracle.olapi.transaction">TransactionTypeUnavailableException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="getCurrentStateForRead()"></A><H3>
getCurrentStateForRead</H3>
<PRE>
protected <A HREF="../../../../oracle/olapi/transaction/metadataStateManager/MetadataState.html" title="interface in oracle.olapi.transaction.metadataStateManager">MetadataState</A> getCurrentStateForRead()
 throws <A HREF="../../../../oracle/olapi/transaction/TransactionalObjectInvalidException.html" title="class in oracle.olapi.transaction">TransactionalObjectInvalidException</A>,
 <A HREF="../../../../oracle/olapi/transaction/TransactionTypeUnavailableException.html" title="class in oracle.olapi.transaction">TransactionTypeUnavailableException</A>,
 <A HREF="../../../../oracle/olapi/transaction/TransactionInactiveException.html" title="class in oracle.olapi.transaction">TransactionInactiveException</A></PRE>
<DL>
<DD>Gets the actual <CODE>MetadataState</CODE> object for this 
 <code>Template</code> rather than a clone of the state.
 Do not modify the state returned by this method; use it only for
 read operations.

<DD><DL>

<DT>Returns:<DD>The current state for this <code>Template</code>.
<DT>Throws:
<DD><CODE><A HREF="../../../../oracle/olapi/transaction/TransactionalObjectInvalidException.html" title="class in oracle.olapi.transaction">TransactionalObjectInvalidException</A></CODE>
<DD><CODE><A HREF="../../../../oracle/olapi/transaction/TransactionTypeUnavailableException.html" title="class in oracle.olapi.transaction">TransactionTypeUnavailableException</A></CODE>
<DD><CODE><A HREF="../../../../oracle/olapi/transaction/TransactionInactiveException.html" title="class in oracle.olapi.transaction">TransactionInactiveException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="getCurrentStateForWrite()"></A><H3>
getCurrentStateForWrite</H3>
<PRE>
protected <A HREF="../../../../oracle/olapi/transaction/metadataStateManager/MetadataState.html" title="interface in oracle.olapi.transaction.metadataStateManager">MetadataState</A> getCurrentStateForWrite()
 throws <A HREF="../../../../oracle/olapi/transaction/TransactionalObjectInvalidException.html" title="class in oracle.olapi.transaction">TransactionalObjectInvalidException</A>,
 <A HREF="../../../../oracle/olapi/transaction/TransactionTypeUnavailableException.html" title="class in oracle.olapi.transaction">TransactionTypeUnavailableException</A>,
 <A HREF="../../../../oracle/olapi/transaction/TransactionInactiveException.html" title="class in oracle.olapi.transaction">TransactionInactiveException</A></PRE>
<DL>
<DD>Gets the current state for this <code>Template</code>.
 The returned state is a clone of the actual state, so
 you can modify it.
 If you modify it, then you must reset the state by passing
 it to the <CODE>setCurrentState</CODE> method.

<DD><DL>

<A NAME="getDataProvider()"></A><H3>
getDataProvider</H3>
<PRE>
public <A HREF="../../../../oracle/olapi/data/source/DataProvider.html" title="class in oracle.olapi.data.source">DataProvider</A> getDataProvider()</PRE>
<DL>
<DD>Gets the <CODE>DataProvider</CODE> for this <CODE>Template</CODE>.

<DD><DL>

<DT>Returns:<DD>The <CODE>DataProvider</CODE> with which this
 <CODE>Template</CODE> was constructed.</DL>
</DD>
</DL>
<HR>

<A NAME="setCurrentState(oracle.olapi.transaction.metadataStateManager.MetadataState)"></A><H3>
setCurrentState</H3>
<PRE>
protected void setCurrentState(<A HREF="../../../../oracle/olapi/transaction/metadataStateManager/MetadataState.html" title="interface in oracle.olapi.transaction.metadataStateManager">MetadataState</A>&nbsp;state)
 throws <A HREF="../../../../oracle/olapi/data/source/CursorLockException.html" title="class in oracle.olapi.data.source">CursorLockException</A>,
 <A HREF="../../../../oracle/olapi/transaction/WriteLockException.html" title="class in oracle.olapi.transaction">WriteLockException</A>,
 <A HREF="../../../../oracle/olapi/transaction/TransactionTypeUnavailableException.html" title="class in oracle.olapi.transaction">TransactionTypeUnavailableException</A>,
 <A HREF="../../../../oracle/olapi/transaction/TransactionInactiveException.html" title="class in oracle.olapi.transaction">TransactionInactiveException</A></PRE>
<DL>
<DD>Specifies a state as the current state for this <code>Template</code>.

<DD><DL>
<DT>Parameters:<DD><CODE>state</CODE> - The state to specify as the current state for this
 <code>Template</code>.
<DT>Throws:
<DD><CODE><A HREF="../../../../oracle/olapi/data/source/CursorLockException.html" title="class in oracle.olapi.data.source">CursorLockException</A></CODE>
<DD><CODE><A HREF="../../../../oracle/olapi/transaction/TransactionInactiveException.html" title="class in oracle.olapi.transaction">TransactionInactiveException</A></CODE>
<DD><CODE><A HREF="../../../../oracle/olapi/transaction/TransactionTypeUnavailableException.html" title="class in oracle.olapi.transaction">TransactionTypeUnavailableException</A></CODE>
<DD><CODE><A HREF="../../../../oracle/olapi/transaction/WriteLockException.html" title="class in oracle.olapi.transaction">WriteLockException</A></CODE></DL>
</DD>
</DL>

<HR>

<A NAME="navbar_bottom"></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 <TR ALIGN="center" VALIGN="top">
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html">Overview</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A>&nbsp;</TD>
 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;Class&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html">Tree</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html">Deprecated</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html">Index</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html">Help</A>&nbsp;</TD>
 </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3>
<center>Copyright &copy; 2002, 2009, Oracle. All rights reserved.</center>
</TD>
</TR>

</TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3">
 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></TD>
<TD VALIGN="top" CLASS="NavBarCell3">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>

<HR>

</BODY>
</HTML>

Ms-Dos/Windows Unix Write backup

jsp File Browser version 1.2 by www.vonloesch.de