Oracle® OLAP Analytic Workspace Java API Reference
10g Release 2 (10.2)

B14351-01

oracle.AWAction
Class Interaction

java.lang.Object
  |
  +--oracle.AWAction.Interaction

public class Interaction
extends java.lang.Object

Assembles a series of actions into a unit of work to perform on an analytic workspace. Actions are represented by AWAction objects. The Interaction class includes methods for creating AWAction objects and adding and removing them from the Interaction. An Interaction is associated with a specific connection to the database.

See Also:
AWAction

Constructor Summary
Interaction()
Creates a new Interaction.

Method Summary
void addAWAction(AWAction input)
Adds the specified action object to the Interaction.
AWAction createAction(java.lang.String actionType)
Creates an action object of the specified type and adds it to the Interaction.
void execute()
Executes the Interaction.
static java.lang.String Execute(oracle.sql.CLOB input)
Executes an XML string that specifies one or more actions to perform on the analytic workspace.
static java.lang.String ExecuteBuild(oracle.sql.CLOB input)
Executes an XML string that specifies the BuildDatabase action.
java.util.Vector getAWActions()
Gets all of the action objects in the Interaction.
AWConnection getConnection()
Gets the current database connection.
java.lang.String getResult()
Gets the results of the actions specified by the Interaction.
void removeAllAWActions()
Removes all of the action objects from the Interaction.
void removeAWAction(AWAction input)
Removes the specified action object from the Interaction.
void setConnection(AWConnection input)
Specifies a connection to an Oracle Database instance.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Interaction

public Interaction()
Creates a new Interaction.

Method Detail

getConnection

public AWConnection getConnection()
Gets the current database connection.
Returns:
The AWConnection that specifies the connection.

setConnection

public void setConnection(AWConnection input)
Specifies a connection to an Oracle Database instance.
Parameters:
input - The AWConnection that specifies the connection.

addAWAction

public void addAWAction(AWAction input)
Adds the specified action object to the Interaction.
Parameters:
input - The AWAction to add.

removeAWAction

public void removeAWAction(AWAction input)
Removes the specified action object from the Interaction.
Parameters:
input - The AWAction to remove.

removeAllAWActions

public void removeAllAWActions()
Removes all of the action objects from the Interaction.

getAWActions

public java.util.Vector getAWActions()
Gets all of the action objects in the Interaction.
Returns:
A Vector of AWAction objects.

getResult

public java.lang.String getResult()
Gets the results of the actions specified by the Interaction.
Returns:
A String containing the results of the processing specified in the Interaction.

createAction

public AWAction createAction(java.lang.String actionType)
Creates an action object of the specified type and adds it to the Interaction. The types of objects that you can specify are the following.

  Alter
  Attach
  BuildDatabase
  Commit
  Create
  Delete
  Detach

For example, the following code creates a Delete object and adds it to the Interaction.

 Interaction curInteraction = new Interaction();
 AWAction awActionObj = curInteraction.createAction("Delete");
Parameters:
actionType - A String that specifies the type of action object to create.
Returns:
The new AWAction object.


execute

public void execute()
Executes the Interaction.

Execute

public static java.lang.String Execute(oracle.sql.CLOB input)
Executes an XML string that specifies one or more actions to perform on the analytic workspace.
Parameters:
input - A CLOB that contains the XML string.
Returns:
A String that contains Success if the method successully executes the actions.

ExecuteBuild

public static java.lang.String ExecuteBuild(oracle.sql.CLOB input)
Executes an XML string that specifies the BuildDatabase action.
Parameters:
input - A CLOB that contains the XML string.
Returns:
A String that contains Success if the method successully executes the actions.

Oracle® OLAP Analytic Workspace Java API Reference
10g Release 2 (10.2)

B14351-01

Copyright © 2003, 2005 Oracle. All rights reserved.