|
|
|||||
| Package com.dassault_systemes.enovwebsrvr.ews0infra.interfaces |
Interface ENOVIQuery
|
| Class Hierarchy |
com.dassault_systemes.enovwebsrvr.ews0infra.interfaces.ENOVIQuery
| Class Location |
| Class Description |
public interface ENOVIQuery
Interface for query execution.
| Field Summary |
| public static final String | DRIVER_CATEGORY
The category value passed to the ENOVWebDriverDefinition class to retrieve the driver instance. |
| public static final String | OPERATOR_BETWEEN
|
| public static final String | OPERATOR_EQ
|
| public static final String | OPERATOR_GT
|
| public static final String | OPERATOR_GTE
|
| public static final String | OPERATOR_IN
|
| public static final String | OPERATOR_LIKE
|
| public static final String | OPERATOR_LT
|
| public static final String | OPERATOR_LTE
|
| public static final String | OPERATOR_NEQ
|
| public static final String | OPERATOR_NOT_IN
|
| Constructor Summary |
| Method Summary |
| public boolean | addCriteria(ENOVIAttribute iAttr, String iExpression)
Adds query criteria to row 0. |
| public boolean | addCriteria(ENOVIAttribute iAttr, String iExpression, int iRow)
Adds query criteria for a specific row, where each row of criteria are "OR" conditions. |
| public boolean | addCriteria(ENOVIAttribute iAttr, String iOperator, String iOperand, int iRow)
Adds query criteria for a specific row. |
| public boolean | addCriteria(String iAttrID, String iExpression)
Adds query criteria to row 0. |
| public boolean | addCriteria(String iAttrID, String iExpression, int iRow)
Adds query criteria for a specific row, where each row of criteria are "OR" conditions. |
| public ENOVIDataObject[] | getQueryResults()
Returns all results for the query |
| public ENOVIDataObject[] | getQueryResults(int startingElement, int numElements)
Executes the query and returns the data range from the query. |
| public String | getQueryXml()
Gets an xml string representation of this query |
| public boolean | initialize(String DataType)
Initialize the data type for the query. |
| public int | runQuery()
Executes the query and returns the number of results. |
| public void | setCaseSensitive(boolean iCaseSensitive)
Specifies the case sensitivity for the query. |
| public void | setGetAllVersions(boolean iGetAllVersions)
Specifies retrieval of all versions or only the latest (where applicable) |
| public boolean | setOrderBy(ENOVIAttribute iAttr, boolean iAsc)
|
| public boolean | setOrderBy(String iAttrID, boolean iAsc)
|
| Field Detail |
public static final String DRIVER_CATEGORY
The category value passed to the ENOVWebDriverDefinition class to retrieve the driver instance.
public static final String OPERATOR_BETWEEN
public static final String OPERATOR_EQ
public static final String OPERATOR_GT
public static final String OPERATOR_GTE
public static final String OPERATOR_IN
public static final String OPERATOR_LIKE
public static final String OPERATOR_LT
public static final String OPERATOR_LTE
public static final String OPERATOR_NEQ
public static final String OPERATOR_NOT_IN
| Constructor Detail |
| Method Detail |
public boolean addCriteria(ENOVIAttribute iAttr, String iExpression)
Adds query criteria to row 0. The user expression will be parsed
and the operator is assumed to be "like".
Returns true if criteria was added successfully
public boolean addCriteria(ENOVIAttribute iAttr, String iExpression, int iRow)
Adds query criteria for a specific row, where each row of criteria
are "OR" conditions. The user expression will be parsed
and the operator is assumed to be "like".
Returns true if criteria was added successfully
public boolean addCriteria(ENOVIAttribute iAttr, String iOperator, String iOperand, int iRow)
Adds query criteria for a specific row.
Returns true if criteria was added successfully
public boolean addCriteria(String iAttrID, String iExpression)
Adds query criteria to row 0. The user expression will be parsed
and the operator is assumed to be "like".
Returns true if criteria was added successfully
public boolean addCriteria(String iAttrID, String iExpression, int iRow)
Adds query criteria for a specific row, where each row of criteria
are "OR" conditions. The user expression will be parsed
and the operator is assumed to be "like".
Returns true if criteria was added successfully
public ENOVIDataObject[] getQueryResults()
Returns all results for the query
public ENOVIDataObject[] getQueryResults(int startingElement, int numElements)
Executes the query and returns the data range from the query.
The startingElement index is base 0.
public String getQueryXml()
Gets an xml string representation of this query
public boolean initialize(String DataType)
Initialize the data type for the query.
public int runQuery()
Executes the query and returns the number of results.
public void setCaseSensitive(boolean iCaseSensitive)
Specifies the case sensitivity for the query. Default case
sensitivity is implemenation specific.
public void setGetAllVersions(boolean iGetAllVersions)
Specifies retrieval of all versions or only the latest (where applicable)
public boolean setOrderBy(ENOVIAttribute iAttr, boolean iAsc)
public boolean setOrderBy(String iAttrID, boolean iAsc)