com.sapportals.connector.metadata
Interface ICapabilities

All Superinterfaces:

ISOAPSerializable

public interface ICapabilities

extends ISOAPSerializable

This interface exposes the functionality of a specific connector. The Connector exposes capabilities interface for each connector version, enumerating the possible capabilities a connector can offer. Each connector will implement the interface in a way that reflects the capabilities that connector actually supports. In other words, if connector X supports capability Y, it will implement the capabilities interface function Y_Supported to return true. This allows consumers to easily understand what modules or functions the connector supports

Version:

1.0

Field Summary

static java.lang.String	CONNECTION_METADATA_PROPERTY_GROUPS The connector implementation supports retrieving connection property groups other than the default one
static java.lang.String	DELETE The connector implementation supports DELETE operations through queries.
static java.lang.String	INSERT The connector implementation supports INSERT operations through queries.
static java.lang.String	INTERACTION_EXECUTION The connector implementation supports the JCA Interaction interfaces i.e.: support for EIS function execution .
static java.lang.String	INTERACTION_EXECUTION_OUTPUT_INDEXED The output format of the Interaction.execute() function is an indexed record
static java.lang.String	INTERACTION_EXECUTION_OUTPUT_MAPPED The output format of the Interaction.execute() function is a mapped record
static java.lang.String	METADATA_FUNCTIONS The connector implementation supports retrieving of functions metadata from the EIS
static java.lang.String	METADATA_FUNCTIONS_REG_EXP The connector implementation supports retrieving of functions metadata from the EIS using regular expressions - for example: the connector implements - Set getFunctions(String functionNameRegularExpression, String functionGroupRegularExpression)
static java.lang.String	METADATA_OPERATORS_EQUAL The connector implementation supports retrieving of conditions with the equal operator - Equal conditions are conditions of type: A.x = value object A attribute x is equal to value.
static java.lang.String	METADATA_OPERATORS_GREATER_THAN The connector implementation supports retrieving of conditions with the greater than operator - Greater than conditions are conditions of type: A.x GREATERTHAN value object A attribute x is greater than to value.
static java.lang.String	METADATA_OPERATORS_GREATER_THAN_OR_EQUAL The connector implementation supports retrieving of conditions with the greater than or equal operator - Greater than or equal conditions are conditions of type: A.x GREATERTHANOREQUAL value object A attribute x is greater than or equal to value.
static java.lang.String	METADATA_OPERATORS_LESS_THAN The connector implementation supports retrieving of conditions with the less than operator - Less than conditions are conditions of type: A.x LESSTHAN value object A attribute x is less than to value.
static java.lang.String	METADATA_OPERATORS_LESS_THAN_OR_EQUAL The connector implementation supports retrieving of conditions with the less than or equal operator Less than or equal conditions are conditions of type: A.x LESSTHANOREQUAL value - object A attribute x is less than or equal to value.
static java.lang.String	METADATA_OPERATORS_LIKE The connector implementation supports retrieving of conditions with the like operator - Like conditions are conditions of type: A.x LIKE value object A attribute x is like to value.
static java.lang.String	METADATA_OPERATORS_NOT_EQUAL The connector implementation supports retrieving of conditions with the not equal operator - Not equal conditions are conditions of type: A.x NOTEQUAL value object A attribute x is not equal to value.
static java.lang.String	MULTILANGUAGE The connector implementation supports multilanguage - input/output values can be multilanguage
static java.lang.String	NATIVE The connector implementation supports the INative interface
static java.lang.String	QUERY The connector implementation supports queries.
static java.lang.String	QUERY_BLACKBOX_JOIN The connector implementation supports execution of queries that contain blackbox relation.
static java.lang.String	QUERY_CANCEL The connector implementation supports cancellation of queries during the execution.
static java.lang.String	QUERY_CRITERIA_LOGICAL_AND The connector implementation supports compound criteria using AND as operator in the WHERE clause
static java.lang.String	QUERY_CRITERIA_LOGICAL_NOT The connector implementation supports logical criteria using NOT as operator in the WHERE clause
static java.lang.String	QUERY_CRITERIA_LOGICAL_OR The connector implementation supports compound criteria using OR as operator in the WHERE clause
static java.lang.String	QUERY_CRITERIA_PREDICATE_ATTRIBUTE_EQUALS_CONSTANT The connector implementation supports only predicate criteria of the following types in the WHERE clause: businessObject.attribute = CONSTANT Blackbox relation
static java.lang.String	QUERY_CRITERIA_PREDICATE_ISNULL The connector implementation supports the IS NULL predicate criteria in the WHERE clause
static java.lang.String	QUERY_CRITERIA_PREDICATE_SET The connector implementation supports the IN () predicate criteria in the WHERE clause.
static java.lang.String	QUERY_FROM_ALIAS The connector implementation supports aliases for business objects in the FROM clause of the query statement
static java.lang.String	QUERY_FROM_INNERJOIN The connector implementation supports inner joins in the FROM clause of the query statement
static java.lang.String	QUERY_FULLSCAN Connector which doesn't support full scan, supports only query statements where the field attributes, participating in the WHERE clause are indexes (WHERE clause is mandatory).
static java.lang.String	QUERY_NATIVE The connector implementation supports the INativeQuery interface - can execute native queries.
static java.lang.String	QUERY_RESULT_CHUNK_SUPPORT The connector implementation supports the retrieval of queries resultSets in chunks - defining the size of a chunk - how many records return in each chunk, and retrieving these chunks one by one..
static java.lang.String	QUERY_SELECT_AGGREGATION_AVG The connector implementation supports AVG (attribute) or AVG (DISTINCT attribute) aggregation function in the SELECT clause of the query statement
static java.lang.String	QUERY_SELECT_AGGREGATION_COUNT The connector implementation supports COUNT (attribute) or COUNT (DISTINCT attribute) aggregation function in the SELECT clause of the query statement
static java.lang.String	QUERY_SELECT_AGGREGATION_COUNT_STAR The connector implementation supports COUNT (*) or COUNT (DISTINCT *) aggregation function in the SELECT clause of the query statement
static java.lang.String	QUERY_SELECT_AGGREGATION_DISTINCT The connector implementation supports DISTINCT keyword in the aggregation function in the SELECT clause of the query statement
static java.lang.String	QUERY_SELECT_AGGREGATION_MAX The connector implementation supports MAX (attribute) or MAX (DISTINCT attribute) aggregation function in the SELECT clause of the query statement
static java.lang.String	QUERY_SELECT_AGGREGATION_MIN The connector implementation supports MIN (attribute) or MIN (DISTINCT attribute) aggregation function in the SELECT clause of the query statement
static java.lang.String	QUERY_SELECT_AGGREGATION_SUM The connector implementation supports SUM (attribute) or SUM (DISTINCT attribute) aggregation function in the SELECT clause of the query statement
static java.lang.String	QUERY_SELECT_ALIAS The connector implementation supports aliases in the SELECT clause of the query statement
static java.lang.String	QUERY_SELECT_DISTINCT The connector implementation supports DISTINCT keyword in the SELECT clause of the query statement
static java.lang.String	QUERY_SELECT_LEAF_BUSINESS_OBJECT_ATTRIBUTE The connector implementation supports query statement that The FROM clause is a join tree - primary-foreign key joins.
static java.lang.String	QUERY_SELECT_SINGLE_BUSINESS_OBJECT_ATTRIBUTE The connector implementation only supports queries where the SELECT clause contain attributes from a single business object
static java.lang.String	QUERY_SORT The connector implementation supports ORDER BY clause in the query statement.
static java.lang.String	TRANSACTIONS The connector implementation supports transactions
static java.lang.String	UPDATE The connector implementation supports UPDATE operations through queries.

Method Summary

java.util.Set	getAllSupportedCapabilities() Returns all capabilities supported by this connector.
boolean	supports(java.lang.String capabilityName) Returns whether a certain capability is supported by this connector.

Field Detail

TRANSACTIONS

public static final java.lang.String TRANSACTIONS

The connector implementation supports transactions

MULTILANGUAGE

public static final java.lang.String MULTILANGUAGE

The connector implementation supports multilanguage - input/output values can be multilanguage

NATIVE

public static final java.lang.String NATIVE

The connector implementation supports the INative interface

INTERACTION_EXECUTION

public static final java.lang.String INTERACTION_EXECUTION

The connector implementation supports the JCA Interaction interfaces i.e.: support for EIS function execution .

INTERACTION_EXECUTION_OUTPUT_MAPPED

public static final java.lang.String INTERACTION_EXECUTION_OUTPUT_MAPPED

The output format of the Interaction.execute() function is a mapped record

INTERACTION_EXECUTION_OUTPUT_INDEXED

public static final java.lang.String INTERACTION_EXECUTION_OUTPUT_INDEXED

The output format of the Interaction.execute() function is an indexed record

QUERY_SORT

public static final java.lang.String QUERY_SORT

The connector implementation supports ORDER BY clause in the query statement.

QUERY_BLACKBOX_JOIN

public static final java.lang.String QUERY_BLACKBOX_JOIN

The connector implementation supports execution of queries that contain blackbox relation. Blackbox relation is a join relation that can only be interpreted by a connector it is NOT a simple key comparison of a type A.x=B.y, but may be a function name or some other string token. The source with this capability may or may not be able to process other join relationships according to other capabilities.

QUERY_RESULT_CHUNK_SUPPORT

public static final java.lang.String QUERY_RESULT_CHUNK_SUPPORT

The connector implementation supports the retrieval of queries resultSets in chunks - defining the size of a chunk - how many records return in each chunk, and retrieving these chunks one by one..

QUERY_CANCEL

public static final java.lang.String QUERY_CANCEL

The connector implementation supports cancellation of queries during the execution.

METADATA_FUNCTIONS

public static final java.lang.String METADATA_FUNCTIONS

The connector implementation supports retrieving of functions metadata from the EIS

METADATA_FUNCTIONS_REG_EXP

public static final java.lang.String METADATA_FUNCTIONS_REG_EXP

The connector implementation supports retrieving of functions metadata from the EIS using regular expressions - for example: the connector implements - Set getFunctions(String functionNameRegularExpression, String functionGroupRegularExpression)

METADATA_OPERATORS_EQUAL

public static final java.lang.String METADATA_OPERATORS_EQUAL

The connector implementation supports retrieving of conditions with the equal operator - Equal conditions are conditions of type: A.x = value object A attribute x is equal to value.

METADATA_OPERATORS_LESS_THAN_OR_EQUAL

public static final java.lang.String METADATA_OPERATORS_LESS_THAN_OR_EQUAL

The connector implementation supports retrieving of conditions with the less than or equal operator Less than or equal conditions are conditions of type: A.x LESSTHANOREQUAL value - object A attribute x is less than or equal to value.

METADATA_OPERATORS_LESS_THAN

public static final java.lang.String METADATA_OPERATORS_LESS_THAN

The connector implementation supports retrieving of conditions with the less than operator - Less than conditions are conditions of type: A.x LESSTHAN value object A attribute x is less than to value.

METADATA_OPERATORS_GREATER_THAN_OR_EQUAL

public static final java.lang.String METADATA_OPERATORS_GREATER_THAN_OR_EQUAL

The connector implementation supports retrieving of conditions with the greater than or equal operator - Greater than or equal conditions are conditions of type: A.x GREATERTHANOREQUAL value object A attribute x is greater than or equal to value.

METADATA_OPERATORS_GREATER_THAN

public static final java.lang.String METADATA_OPERATORS_GREATER_THAN

The connector implementation supports retrieving of conditions with the greater than operator - Greater than conditions are conditions of type: A.x GREATERTHAN value object A attribute x is greater than to value.

METADATA_OPERATORS_NOT_EQUAL

public static final java.lang.String METADATA_OPERATORS_NOT_EQUAL

The connector implementation supports retrieving of conditions with the not equal operator - Not equal conditions are conditions of type: A.x NOTEQUAL value object A attribute x is not equal to value.

METADATA_OPERATORS_LIKE

public static final java.lang.String METADATA_OPERATORS_LIKE

The connector implementation supports retrieving of conditions with the like operator - Like conditions are conditions of type: A.x LIKE value object A attribute x is like to value.

CONNECTION_METADATA_PROPERTY_GROUPS

public static final java.lang.String CONNECTION_METADATA_PROPERTY_GROUPS

The connector implementation supports retrieving connection property groups other than the default one

QUERY_SELECT_ALIAS

public static final java.lang.String QUERY_SELECT_ALIAS

The connector implementation supports aliases in the SELECT clause of the query statement

QUERY_SELECT_DISTINCT

public static final java.lang.String QUERY_SELECT_DISTINCT

The connector implementation supports DISTINCT keyword in the SELECT clause of the query statement

QUERY_SELECT_AGGREGATION_DISTINCT

public static final java.lang.String QUERY_SELECT_AGGREGATION_DISTINCT

The connector implementation supports DISTINCT keyword in the aggregation function in the SELECT clause of the query statement

QUERY_SELECT_AGGREGATION_COUNT_STAR

public static final java.lang.String QUERY_SELECT_AGGREGATION_COUNT_STAR

The connector implementation supports COUNT (*) or COUNT (DISTINCT *) aggregation function in the SELECT clause of the query statement

QUERY_SELECT_AGGREGATION_COUNT

public static final java.lang.String QUERY_SELECT_AGGREGATION_COUNT

The connector implementation supports COUNT (attribute) or COUNT (DISTINCT attribute) aggregation function in the SELECT clause of the query statement

QUERY_SELECT_AGGREGATION_SUM

public static final java.lang.String QUERY_SELECT_AGGREGATION_SUM

The connector implementation supports SUM (attribute) or SUM (DISTINCT attribute) aggregation function in the SELECT clause of the query statement

QUERY_SELECT_AGGREGATION_AVG

public static final java.lang.String QUERY_SELECT_AGGREGATION_AVG

The connector implementation supports AVG (attribute) or AVG (DISTINCT attribute) aggregation function in the SELECT clause of the query statement

QUERY_SELECT_AGGREGATION_MIN

public static final java.lang.String QUERY_SELECT_AGGREGATION_MIN

The connector implementation supports MIN (attribute) or MIN (DISTINCT attribute) aggregation function in the SELECT clause of the query statement

QUERY_SELECT_AGGREGATION_MAX

public static final java.lang.String QUERY_SELECT_AGGREGATION_MAX

The connector implementation supports MAX (attribute) or MAX (DISTINCT attribute) aggregation function in the SELECT clause of the query statement

QUERY_SELECT_SINGLE_BUSINESS_OBJECT_ATTRIBUTE

public static final java.lang.String QUERY_SELECT_SINGLE_BUSINESS_OBJECT_ATTRIBUTE

The connector implementation only supports queries where the SELECT clause contain attributes from a single business object

QUERY_FROM_INNERJOIN

public static final java.lang.String QUERY_FROM_INNERJOIN

The connector implementation supports inner joins in the FROM clause of the query statement

QUERY_FROM_ALIAS

public static final java.lang.String QUERY_FROM_ALIAS

The connector implementation supports aliases for business objects in the FROM clause of the query statement

QUERY_CRITERIA_LOGICAL_AND

public static final java.lang.String QUERY_CRITERIA_LOGICAL_AND

The connector implementation supports compound criteria using AND as operator in the WHERE clause

QUERY_CRITERIA_LOGICAL_OR

public static final java.lang.String QUERY_CRITERIA_LOGICAL_OR

The connector implementation supports compound criteria using OR as operator in the WHERE clause

QUERY_CRITERIA_LOGICAL_NOT

public static final java.lang.String QUERY_CRITERIA_LOGICAL_NOT

The connector implementation supports logical criteria using NOT as operator in the WHERE clause

QUERY_CRITERIA_PREDICATE_ISNULL

public static final java.lang.String QUERY_CRITERIA_PREDICATE_ISNULL

The connector implementation supports the IS NULL predicate criteria in the WHERE clause

QUERY_CRITERIA_PREDICATE_SET

public static final java.lang.String QUERY_CRITERIA_PREDICATE_SET

The connector implementation supports the IN () predicate criteria in the WHERE clause. Sub queries as the set criteria are not supported

QUERY_CRITERIA_PREDICATE_ATTRIBUTE_EQUALS_CONSTANT

public static final java.lang.String QUERY_CRITERIA_PREDICATE_ATTRIBUTE_EQUALS_CONSTANT

The connector implementation supports only predicate criteria of the following types in the WHERE clause:

1. businessObject.attribute = CONSTANT
2. Blackbox relation

QUERY_FULLSCAN

public static final java.lang.String QUERY_FULLSCAN

Connector which doesn't support full scan, supports only query statements where the field attributes, participating in the WHERE clause are indexes (WHERE clause is mandatory). Other queries (without WHERE statement clause or with the WHERE statement on fields, which are not indexes - will NOT be supported.

QUERY_SELECT_LEAF_BUSINESS_OBJECT_ATTRIBUTE

public static final java.lang.String QUERY_SELECT_LEAF_BUSINESS_OBJECT_ATTRIBUTE

The connector implementation supports query statement that

1. The FROM clause is a join tree - primary-foreign key joins. The join predicates in the FROM clause are only of the parent-child type. Typical example are elements in XML DOM object
2. The SELECT clause contains only attributes from the leaf business objects. i.e only from the child business objects and not from the parent business object

DELETE

public static final java.lang.String DELETE

The connector implementation supports DELETE operations through queries.

INSERT

public static final java.lang.String INSERT

The connector implementation supports INSERT operations through queries.

UPDATE

public static final java.lang.String UPDATE

The connector implementation supports UPDATE operations through queries.

QUERY

public static final java.lang.String QUERY

The connector implementation supports queries. Query can be of any kind - update, select, delete or insert. The assumption is that the connector also exposes metadata for the query objects in this case.

QUERY_NATIVE

public static final java.lang.String QUERY_NATIVE

The connector implementation supports the INativeQuery interface - can execute native queries.

Method Detail

supports

public boolean supports(java.lang.String capabilityName)
                 throws CapabilityNotFoundException

Returns whether a certain capability is supported by this connector.

Parameters:

capabilityName - The name of the capability.

Returns:

boolean indicating whether the capability is supported or not.

getAllSupportedCapabilities

public java.util.Set getAllSupportedCapabilities()

Returns all capabilities supported by this connector.

Returns:

Set of all capabilities supported.