com.sap.tc.col.client.metadata.api
Interface IQueryDescriptor

public interface IQueryDescriptor

Describes the properties of a query.

Field Summary

static java.lang.String	ATTRIBUTE_PAGING_MODE The backend name of the system attribute PagingMode.
static java.lang.String	PAGING_MODE_FORWARD_PAGING Possible value for attribute PagingMode: forward paging is switched on.
static java.lang.String	PAGING_MODE_NO_PAGING Possible value for attribute PagingMode: paging is switched off.

Method Summary

java.lang.String[]	getAttributeNames() Returns an array with the names of all the attributes which are set for this query.
java.lang.String	getAttributePagingMode() Returns the paging mode supported by this query.
java.lang.String	getAttributeStringValue(java.lang.String attributeName) Returns the value that is stored in this query for the given attribute.
java.lang.String	getDescription() Returns the description of this query.
java.lang.String[]	getFieldAttributeNames(java.lang.String fieldName) Returns an array with the names of all the attributes for a specified field of the input parameter structure.
java.lang.String	getFieldAttributeStringValue(java.lang.String fieldName, java.lang.String attributeName) Returns the value that is stored in this query for the given attribute of the given field (of the input parameter structure).
IKeyAspectDescriptor	getInputKeysDescriptor() Returns the descriptor of the input keys of this query.
IStructureDescriptor	getInputOptions() Returns the input options structure for this query.
IStructureDescriptor	getInputParameters() Returns the input parameters for this query.
java.lang.String	getName() Returns the name of the query.
IAspectDescriptor	getResultAspectDescriptor() Returns the descriptor of the result aspect of this query.
IStructureDescriptor	getSelections() Returns the selections structure for this query.
IServiceModuleDescriptor	getServiceModuleDescriptor() Returns the descriptor of the service module in which this query is cached.
IStructureDescriptor	getSortingOptions() Returns the sorting options structure for this query.
boolean	hasInputKeys() Returns whether the query has input keys.
boolean	hasInputParameters() Returns whether the query has inputParameters.

Field Detail

ATTRIBUTE_PAGING_MODE

public static final java.lang.String ATTRIBUTE_PAGING_MODE

The backend name of the system attribute PagingMode.

PAGING_MODE_NO_PAGING

public static final java.lang.String PAGING_MODE_NO_PAGING

Possible value for attribute PagingMode: paging is switched off.

PAGING_MODE_FORWARD_PAGING

public static final java.lang.String PAGING_MODE_FORWARD_PAGING

Possible value for attribute PagingMode: forward paging is switched on.

Method Detail

getName

public java.lang.String getName()

Returns the name of the query.

Returns:

name of the query.

getDescription

public java.lang.String getDescription()

Returns the description of this query.

Returns:

String the short text description of the query

getServiceModuleDescriptor

public IServiceModuleDescriptor getServiceModuleDescriptor()

Returns the descriptor of the service module in which this query is cached.

Returns:

the service module descriptor

hasInputParameters

public boolean hasInputParameters()

Returns whether the query has inputParameters.

Returns:

true if the query has input parameters, otherwise false.

getInputParameters

public IStructureDescriptor getInputParameters()

Returns the input parameters for this query.

Returns:

the input parameter descriptor or null

getInputOptions

public IStructureDescriptor getInputOptions()

Returns the input options structure for this query.

Returns:

the input options structure descriptor or null

getSortingOptions

public IStructureDescriptor getSortingOptions()

Returns the sorting options structure for this query.

Returns:

the sorting options structure descriptor or null

getSelections

public IStructureDescriptor getSelections()

Returns the selections structure for this query.

Returns:

the selections structure descriptor or null

hasInputKeys

public boolean hasInputKeys()

Returns whether the query has input keys.

Returns:

true if the query has input keys, otherwise false.

getInputKeysDescriptor

public IKeyAspectDescriptor getInputKeysDescriptor()

Returns the descriptor of the input keys of this query.

Returns:

the key descriptor for the input parameters of this query.

getResultAspectDescriptor

public IAspectDescriptor getResultAspectDescriptor()

Returns the descriptor of the result aspect of this query.

Returns:

AspectDescriptor

getAttributeStringValue

public java.lang.String getAttributeStringValue(java.lang.String attributeName)

Returns the value that is stored in this query for the given attribute. Attribute names are case sensitive. If the attribute is not stored in this relation, null ist returned.

Parameters:

attributeName - The name of the attribute.

Returns:

The value of the attribute or null.

getAttributeNames

public java.lang.String[] getAttributeNames()

Returns an array with the names of all the attributes which are set for this query.

Returns:

the attribute names.

getAttributePagingMode

public java.lang.String getAttributePagingMode()

Returns the paging mode supported by this query. See the Paging section of the Cool SPI specs for more details on the meaning of this attribute. Supported values:

• initial (blank)
• FORWARD

Default value: blank You are advised to use the constants provided in this interface instead of literal string values.

Returns:

the paging mode supported by this query

Throws:

UnsupportedOperationException - if the backend did not set the system property 'COL_PAGING_MODE' for this relation.

See Also:

PAGING_MODE_NO_PAGING, PAGING_MODE_FORWARD_PAGING

getFieldAttributeStringValue

public java.lang.String getFieldAttributeStringValue(java.lang.String fieldName,
                                                     java.lang.String attributeName)

Returns the value that is stored in this query for the given attribute of the given field (of the input parameter structure). Field and attribute names are case sensitive. If the attribute is not stored for the given field, or if the field does not exist in the structure, null ist returned.

Parameters:

fieldName - The name of the field for which the attribute is stored.

attributeName - The name of the attribute.

Returns:

The value of the attribute or null.

getFieldAttributeNames

public java.lang.String[] getFieldAttributeNames(java.lang.String fieldName)

Returns an array with the names of all the attributes for a specified field of the input parameter structure. The field names in the input parameter structure can be retrieved through with getInputParameters(). If no attributes are set for the given field, an empty array is returned.

Returns:

the attribute names.

Throws:

java.lang.IllegalArgumentException - if the field does not exist in the structure of the input parameter of this query or if this query does not have an input parameter.

See Also:

getInputParameters(), hasInputParameters(), IStructureDescriptor.getFieldDescriptor(int)