|
Style Intelligence v12.0 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface XDataService
This interface defines the API of the runtime query engine. It can be used to find the query parameters and execute queries. An instance of of the XDataService can be obtained from the XFactory class.
| Method Summary | |
|---|---|
Object |
bind(Object uinfo)
Connect to the data service. |
void |
close(Object session)
Close an active session. |
void |
connect(Object session,
String query,
VariableTable params)
Initialize a data source connection. |
void |
connect(Object session,
XDataSource dx,
VariableTable params)
Initialize a data source connection. |
XNode |
execute(Object session,
String query,
VariableTable vars)
Deprecated. |
XNode |
execute(Object session,
String query,
VariableTable vars,
boolean resetVariables)
Deprecated. |
XNode |
execute(Object session,
String query,
VariableTable vars,
Principal user)
Deprecated. |
XNode |
execute(Object session,
String query,
VariableTable vars,
Principal user,
boolean resetVariables)
Deprecated. |
XNode |
execute(Object session,
String query,
VariableTable vars,
Principal user,
boolean resetVariables,
inetsoft.util.DataCacheVisitor visitor)
Execute the query and return the result set. |
XNode |
execute(Object session,
XQuery xquery,
VariableTable vars)
Deprecated. |
XNode |
execute(Object session,
XQuery xquery,
VariableTable vars,
boolean resetVariables)
Deprecated. |
XNode |
execute(Object session,
XQuery xquery,
VariableTable vars,
Principal user)
Deprecated. |
XNode |
execute(Object session,
XQuery xquery,
VariableTable vars,
Principal user,
boolean resetVariables)
Deprecated. |
XNode |
execute(Object session,
XQuery xquery,
VariableTable vars,
Principal user,
boolean resetVariables,
inetsoft.util.DataCacheVisitor visitor)
Execute the query and return the result set. |
UserVariable[] |
getConnectionParameters(Object session,
String query)
Get the parameters for a data source. |
UserVariable[] |
getConnectionParameters(Object session,
XDataSource dx)
Get the parameters for a data source. |
UserVariable[] |
getConnectionParameters(Object session,
XQuery xquery)
Get the parameters for a data source. |
XHandler |
getHandler(Object session,
XDataSource dx,
VariableTable params)
Get the handler. |
UserVariable[] |
getQueryParameters(Object session,
String query,
boolean promptOnly)
Get the parameters for a query. |
UserVariable[] |
getQueryParameters(Object session,
XQuery xquery,
boolean promptOnly)
Get the parameters for a query. |
void |
testDataSource(Object session,
XDataSource dx,
VariableTable params)
Test a data source connection. |
| Method Detail |
|---|
Object bind(Object uinfo)
throws RemoteException,
AccessException
uinfo - user info.
RemoteException
AccessException
UserVariable[] getConnectionParameters(Object session,
String query)
throws RemoteException
session - session object.query - query name.
RemoteException
UserVariable[] getConnectionParameters(Object session,
XQuery xquery)
throws RemoteException
session - session object.xquery - query to get the connection parameters.
RemoteException
UserVariable[] getConnectionParameters(Object session,
XDataSource dx)
throws RemoteException
session - session object.dx - data source to get connection parameters.
RemoteException
UserVariable[] getQueryParameters(Object session,
String query,
boolean promptOnly)
throws RemoteException
session - session object.query - query name.promptOnly - true if only include the user variables that
are declared as 'Prompt User'.
RemoteException
UserVariable[] getQueryParameters(Object session,
XQuery xquery,
boolean promptOnly)
throws RemoteException
session - session object.xquery - query to get parameters.promptOnly - true if only include the user variables that
are declared as 'Prompt User'.
RemoteException
void testDataSource(Object session,
XDataSource dx,
VariableTable params)
throws Exception
session - session object.dx - datasource.params - connection parameters.
Exception
void connect(Object session,
String query,
VariableTable params)
throws Exception
session - session object.query - query name.params - connection parameters.
Exception
void connect(Object session,
XDataSource dx,
VariableTable params)
throws Exception
session - session object.dx - specified data source.params - connection parameters.
Exception
XHandler getHandler(Object session,
XDataSource dx,
VariableTable params)
throws Exception
session - the specified session object.dx - the specified data source.params - the specified variable table.
Exception
XNode execute(Object session,
String query,
VariableTable vars)
throws Exception
session - session object.query - query to execute.vars - variable values for the query.
Exception
XNode execute(Object session,
String query,
VariableTable vars,
boolean resetVariables)
throws Exception
session - session object.query - query to execute.vars - variable values for the query.resetVariables - true if should reset cached variables.
Exception
XNode execute(Object session,
String query,
VariableTable vars,
Principal user)
throws Exception
session - session object.query - query to execute.vars - variable values for the query.user - a Principal object that identifies the user executing the
query.
Exception
XNode execute(Object session,
String query,
VariableTable vars,
Principal user,
boolean resetVariables)
throws Exception
session - session object.query - query to execute.vars - variable values for the query.user - a Principal object that identifies the user executing the
query.resetVariables - true if should reset cached variables.
Exception
XNode execute(Object session,
String query,
VariableTable vars,
Principal user,
boolean resetVariables,
inetsoft.util.DataCacheVisitor visitor)
throws Exception
session - session object.query - query to execute.vars - variable values for the query.user - a Principal object that identifies the user executing the
query.resetVariables - true if should reset cached variables.visitor - used to process cache facility.
Exception
XNode execute(Object session,
XQuery xquery,
VariableTable vars)
throws Exception
session - session object.xquery - query to execute.vars - variable values for the query.
Exception
XNode execute(Object session,
XQuery xquery,
VariableTable vars,
boolean resetVariables)
throws Exception
session - session object.xquery - query to execute.vars - variable values for the query.resetVariables - true if should reset cached variables.
Exception
XNode execute(Object session,
XQuery xquery,
VariableTable vars,
Principal user)
throws Exception
session - session object.xquery - query to execute.vars - variable values for the query.user - a Principal object that identifies the user executing the
query.
Exception
XNode execute(Object session,
XQuery xquery,
VariableTable vars,
Principal user,
boolean resetVariables)
throws Exception
session - session object.xquery - query to execute.vars - variable values for the query.user - a Principal object that identifies the user executing the
query.resetVariables - true if should reset cached variables.
Exception
XNode execute(Object session,
XQuery xquery,
VariableTable vars,
Principal user,
boolean resetVariables,
inetsoft.util.DataCacheVisitor visitor)
throws Exception
session - session object.xquery - query to execute.vars - variable values for the query.user - a Principal object that identifies the user executing the
query.resetVariables - true if should reset cached variables.visitor - used to process cache facility.
Exception
void close(Object session)
throws RemoteException
session - session object.
RemoteException
|
Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved. | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||