org.sdmxsource.sdmx.api.model.data.query.complex

Interface ComplexDataQuery

All Superinterfaces:

BaseDataQuery, java.io.Serializable

All Known Implementing Classes:

ComplexDataQueryImpl

public interface ComplexDataQuery
extends BaseDataQuery

It is a representation of a SOAP DataQuery 2.1

Author:

fch

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDatasetId() Returns the id of the dataset from which data will be returned or null if unspecified
TEXT_SEARCH	getDatasetIdOperator() The id of the dataset requested should satisfy the condition implied by the operator this method returns.
java.lang.Integer	getDefaultLimit() Returns the suggested maximum response size or null if unspecified
java.util.List<TimeRange>	getLastUpdatedDateTimeRange() This method accomplishes the following criteria :match data based on when they were last updated The date points to the start date or the range that the queried date must occur within and/ or to the end period of the range It returns null if unspecified.
OBSERVATION_ACTION	getObservationAction() Returns the type of observations to be returned. Defaults to ACTIVE
ProvisionAgreementBean	getProvisionAgreement() Returns the Provision Agreement that the query is returning data for or null if unspecified
java.util.List<ComplexDataQuerySelectionGroup>	getSelectionGroups() Returns a list of selection groups.
boolean	hasExplicitMeasures() Returns true or false depending on the existence of explicit measures Defaults to false

Methods inherited from interface org.sdmxsource.sdmx.api.model.data.query.BaseDataQuery

dimensionAtObservation, getDataflow, getDataProvider, getDataQueryDetail, getDataStructure, getFirstNObservations, getLastNObservations, hasSelections

Method Detail

getDefaultLimit

java.lang.Integer getDefaultLimit()

Returns the suggested maximum response size or null if unspecified

Returns:

getObservationAction

OBSERVATION_ACTION getObservationAction()

Returns the type of observations to be returned.
Defaults to ACTIVE

Returns:

hasExplicitMeasures

boolean hasExplicitMeasures()

Returns true or false depending on the existence of explicit measures Defaults to false

Returns:

getDatasetId

java.lang.String getDatasetId()

Returns the id of the dataset from which data will be returned or null if unspecified

Returns:

getDatasetIdOperator

TEXT_SEARCH getDatasetIdOperator()

The id of the dataset requested should satisfy the condition implied by the operator this method returns.
For instance if the operator is starts_with then data from a dataset with id that starts with the getDatasetId() result should be returned. Defaults to EQUAL

getLastUpdatedDateTimeRange

java.util.List<TimeRange> getLastUpdatedDateTimeRange()

This method accomplishes the following criteria :match data based on when they were last updated
The date points to the start date or the range that the queried date must occur within and/ or to the end period of the range
It returns null if unspecified.

Returns:

getSelectionGroups

java.util.List<ComplexDataQuerySelectionGroup> getSelectionGroups()

Returns a list of selection groups. The list is empty if no selection groups have been added.

Returns:

getProvisionAgreement

ProvisionAgreementBean getProvisionAgreement()

Returns the Provision Agreement that the query is returning data for or null if unspecified

Returns: