com.sapportals.connector.execution.objects

Interface IQuery

All Superinterfaces:

IAbstractQuery

Deprecated. Use IExecution interface

public interface IQuery
extends IAbstractQuery

The interface IQuery allows a connector client application to perform queries using java API or using a given query string in the Connector Framework SQL language (only a subset of SQL language). The Connector Framework supports the following query syntax: SELECT ObjectUniqueName1.attribute1[, ObjectUniqueName2.attribute2...] FROM ObjectUniqueName1 [AS A] [INNER JOIN ObjectUniqueName2 [AS B] ON {A. attribute1=B. attribute2, blackbox token}..] [WHERE A.attribute1 = value1 [AND B.attribute2 = value2 ..]]. ObjectUniqueName may contain dots as well. Aliases for object names are supported. Attributes from more than one object can be selected. More than one join may appear in the FROM clause. Only simple criteria (=value) may appear in WHERE clause

Method Summary

void	applyCondition(String businessObjectName, String attributeName, Object attributeValue) Deprecated. Apply a condition combined of an attribute and a value.
void	applyCondition(String businessObjectName, String attributeName, Object attributeValue, IOperator conditionOperator) Deprecated. Apply a condition combined of an attribute and a value.
boolean	execute() Deprecated. Use IExecution.execute(IOperation)
boolean	execute(String queryString) Deprecated. Use IExecution.execute(IOperation)
List	getSelectedAttributes(String businessObjectName) Deprecated. Returns the list of attributes of the given object in this query.
void	join(String relation) Deprecated. Perform a join using a EIS relation
void	join(String sourceBusinessObject, String sourceAttribute, String targetBusinessObject, String targetAttribute) Deprecated. Perform a join using a the defualt implementation for relations
boolean	nextRecordSet() Deprecated. Moves to the next record set.
String	retrieveQueryString() Deprecated. Returns the current query string, for debug purposes
IRecordSet	retrieveRecordSet() Deprecated. Returns the current record set.
void	setObjectAlias(String objectName, String alias) Deprecated. Sets an alias to a certain object
void	setSelectedAttributes(String businessObjectName, List attributesList) Deprecated. Set a list of attributes of a certain object for the resultSet of this query.

Methods inherited from interface com.sapportals.connector.execution.objects.IAbstractQuery

cancel, retrieveQueryChunkSize, retrieveQueryTimeOut, setQueryChunkSize, setQueryTimeOut

Method Detail

retrieveRecordSet

IRecordSet retrieveRecordSet()
                             throws ConnectorException

Deprecated.

Returns the current record set. The interface IRecordSet is a set of rows (a subset of java.sql.ResultSet). The number of rows in every record set is determined using the method setQueryChunkSize(). The default is one row per record set.

Returns:

IResultSet the current result set

Throws:

ConnectorException

nextRecordSet

boolean nextRecordSet()
                      throws ConnectorException

Deprecated.

Moves to the next record set. The interface IRecordSet is a set of rows (a subset of java.sql.ResultSet). The number of rows in every record set is determined using the method setQueryChunkSize(). The default is one row per record set.

Returns:

boolean determine whether this is the last result set

Throws:

ConnectorException

execute

boolean execute(String queryString)
                throws InvalidQueryStringException,
                       QueryExecutionException,
                       ConnectorException

Deprecated. Use IExecution.execute(IOperation)

Execute the given query string in this EIS.

Parameters:

queryString - An EIS well formed query string.

Returns:

boolean whether the query executed successfully

Throws:

InvalidQueryStringException

QueryExecutionException

ConnectorException

execute

boolean execute()
                throws QueryExecutionException,
                       ConnectorException

Deprecated. Use IExecution.execute(IOperation)

Execute the query after setting the attributes and conditions using the API.

Returns:

boolean whether the query executed successfully

Throws:

QueryExecutionException

ConnectorException

setSelectedAttributes

void setSelectedAttributes(String businessObjectName,
                           List attributesList)
                           throws ObjectNotFoundException,
                                  AttributeNotFoundException,
                                  ConnectorException

Deprecated.

Set a list of attributes of a certain object for the resultSet of this query. For example: SELECT name,address FROM customers --> name,address are the attributes for the customers object.

Parameters:

businessObjectName - the object name to which these attributes belong

attributesList - a list of attributes to return in the resultSet

Throws:

ObjectNotFoundException

AttributeNotFoundException

ConnectorException

getSelectedAttributes

List getSelectedAttributes(String businessObjectName)
                           throws ObjectNotFoundException,
                                  ConnectorException

Deprecated.

Returns the list of attributes of the given object in this query.

Parameters:

businessObjectName - the name of the object

Returns:

list of attributes of the given object in the query

Throws:

ObjectNotFoundException

ConnectorException

setObjectAlias

void setObjectAlias(String objectName,
                    String alias)
                    throws ObjectNotFoundException,
                           ConnectorException

Deprecated.

Sets an alias to a certain object

Parameters:

objectName - the name of the object

alias - the alias given

Throws:

ObjectNotFoundException

ConnectorException

applyCondition

void applyCondition(String businessObjectName,
                    String attributeName,
                    Object attributeValue)
                    throws ObjectNotFoundException,
                           AttributeNotFoundException,
                           InvalidConditionException,
                           ConnectorException

Deprecated.

Apply a condition combined of an attribute and a value. For example: SELECT name FROM customers WHERE id=333 --> id is the attribute and 333 is the value.

Parameters:

businessObjectName - the name of the object

attributeName - the name of the attribute

attributeValue - the value of the attribute

Throws:

ObjectNotFoundException

AttributeNotFoundException

InvalidConditionException

ConnectorException

applyCondition

void applyCondition(String businessObjectName,
                    String attributeName,
                    Object attributeValue,
                    IOperator conditionOperator)
                    throws ObjectNotFoundException,
                           AttributeNotFoundException,
                           InvalidConditionException,
                           ConnectorException

Deprecated.

Apply a condition combined of an attribute and a value. For example: SELECT name FROM customers WHERE id=333 --> id is the attribute and 333 is the value.

Parameters:

businessObjectName - the name of the object.

attributeName - the name of the attribute.

attributeValue - the value of the attribute.

conditionOperator - the operator of the condition

Throws:

ObjectNotFoundException

AttributeNotFoundException

InvalidConditionException

ConnectorException

join

void join(String sourceBusinessObject,
          String sourceAttribute,
          String targetBusinessObject,
          String targetAttribute)
          throws ObjectNotFoundException,
                 AttributeNotFoundException,
                 ConnectorException

Deprecated.

Perform a join using a the defualt implementation for relations

Parameters:

sourceBusinessObject - the source business object

sourceAttribute - the source attribute

targetBusinessObject - the target business object

targetAttribute - the target attribute

Throws:

ObjectNotFoundException

AttributeNotFoundException

ConnectorException

join

void join(String relation)
          throws InvalidRelationException,
                 ConnectorException

Deprecated.

Perform a join using a EIS relation

Parameters:

relation - The relation string to use for the join

Throws:

InvalidRelationException

ConnectorException

retrieveQueryString

String retrieveQueryString()

Deprecated.

Returns the current query string, for debug purposes

Returns:

String the query string

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] FRAMEWORK-EXT	[sap.com] tc/conn/connectorframeworkdeprecated	default	EP-CON-CF
[sap.com] FRAMEWORK-EXT	[sap.com] tc/conn/connectorframeworkdeprecated	-	EP-CON-CF
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/connectivityfw/api	api	EP-PIN