org.sdmx.resources.sdmxml.schemas.v2_1.registry
Class QueryRegistrationRequestType

java.lang.Object
  org.sdmx.resources.sdmxml.schemas.v2_1.registry.QueryRegistrationRequestType

public class QueryRegistrationRequestType
extends Object

QueryRegistrationRequestType describes the structure of a registration query request. The type of query (data, reference metadata, or both) must be specified. It is possible to query for registrations for a particular provision agreement, data provider, or structure usage, or to query for all registrations in the registry. In addition the search can be refined by providing constraints in the form of explicit time periods, constraint regions, and key sets. When constraint regions and key sets are provided they will be effectively processed by first matching all data for the included keys and regions (all available data if there are none) and then removing any data matching the excluded keys or regions.

Java class for QueryRegistrationRequestType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="QueryRegistrationRequestType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="QueryType" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/registry}QueryTypeType"/>
         <choice>
           <element name="All" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}EmptyType"/>
           <element name="ProvisionAgreement" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}ProvisionAgreementReferenceType"/>
           <element name="DataProvider" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}DataProviderReferenceType"/>
           <element name="Dataflow" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}DataflowReferenceType"/>
           <element name="Metadataflow" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}MetadataflowReferenceType"/>
         </choice>
         <element name="ReferencePeriod" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}ReferencePeriodType" minOccurs="0"/>
         <choice maxOccurs="unbounded" minOccurs="0">
           <element name="DataKeySet" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/structure}DataKeySetType"/>
           <element name="MetadataKeySet" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/structure}MetadataKeySetType"/>
           <element name="CubeRegion" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}CubeRegionType"/>
           <element name="MetadataTargetRegion" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}MetadataTargetRegionType"/>
         </choice>
       </sequence>
       <attribute name="returnConstraints" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

protected EmptyType	all
protected DataflowReferenceType	dataflow
protected List<Object>	dataKeySetOrMetadataKeySetOrCubeRegion
protected DataProviderReferenceType	dataProvider
protected MetadataflowReferenceType	metadataflow
protected ProvisionAgreementReferenceType	provisionAgreement
protected QueryTypeType	queryType
protected ReferencePeriodType	referencePeriod
protected Boolean	returnConstraints

Constructor Summary

QueryRegistrationRequestType()

Method Summary

EmptyType	getAll() Gets the value of the all property.
DataflowReferenceType	getDataflow() Gets the value of the dataflow property.
List<Object>	getDataKeySetOrMetadataKeySetOrCubeRegion() Gets the value of the dataKeySetOrMetadataKeySetOrCubeRegion property.
DataProviderReferenceType	getDataProvider() Gets the value of the dataProvider property.
MetadataflowReferenceType	getMetadataflow() Gets the value of the metadataflow property.
ProvisionAgreementReferenceType	getProvisionAgreement() Gets the value of the provisionAgreement property.
QueryTypeType	getQueryType() Gets the value of the queryType property.
ReferencePeriodType	getReferencePeriod() Gets the value of the referencePeriod property.
boolean	isReturnConstraints() Gets the value of the returnConstraints property.
void	setAll(EmptyType value) Sets the value of the all property.
void	setDataflow(DataflowReferenceType value) Sets the value of the dataflow property.
void	setDataProvider(DataProviderReferenceType value) Sets the value of the dataProvider property.
void	setMetadataflow(MetadataflowReferenceType value) Sets the value of the metadataflow property.
void	setProvisionAgreement(ProvisionAgreementReferenceType value) Sets the value of the provisionAgreement property.
void	setQueryType(QueryTypeType value) Sets the value of the queryType property.
void	setReferencePeriod(ReferencePeriodType value) Sets the value of the referencePeriod property.
void	setReturnConstraints(Boolean value) Sets the value of the returnConstraints property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

queryType

protected QueryTypeType queryType

all

protected EmptyType all

provisionAgreement

protected ProvisionAgreementReferenceType provisionAgreement

dataProvider

protected DataProviderReferenceType dataProvider

dataflow

protected DataflowReferenceType dataflow

metadataflow

protected MetadataflowReferenceType metadataflow

referencePeriod

protected ReferencePeriodType referencePeriod

dataKeySetOrMetadataKeySetOrCubeRegion

protected List<Object> dataKeySetOrMetadataKeySetOrCubeRegion

returnConstraints

protected Boolean returnConstraints

Constructor Detail

QueryRegistrationRequestType

public QueryRegistrationRequestType()

Method Detail

getQueryType

public QueryTypeType getQueryType()

Gets the value of the queryType property.

Returns:

possible object is QueryTypeType

setQueryType

public void setQueryType(QueryTypeType value)

Sets the value of the queryType property.

Parameters:

value - allowed object is QueryTypeType

getAll

public EmptyType getAll()

Gets the value of the all property.

Returns:

possible object is EmptyType

setAll

public void setAll(EmptyType value)

Sets the value of the all property.

Parameters:

value - allowed object is EmptyType

getProvisionAgreement

public ProvisionAgreementReferenceType getProvisionAgreement()

Gets the value of the provisionAgreement property.

Returns:

possible object is ProvisionAgreementReferenceType

setProvisionAgreement

public void setProvisionAgreement(ProvisionAgreementReferenceType value)

Sets the value of the provisionAgreement property.

Parameters:

value - allowed object is ProvisionAgreementReferenceType

getDataProvider

public DataProviderReferenceType getDataProvider()

Gets the value of the dataProvider property.

Returns:

possible object is DataProviderReferenceType

setDataProvider

public void setDataProvider(DataProviderReferenceType value)

Sets the value of the dataProvider property.

Parameters:

value - allowed object is DataProviderReferenceType

getDataflow

public DataflowReferenceType getDataflow()

Gets the value of the dataflow property.

Returns:

possible object is DataflowReferenceType

setDataflow

public void setDataflow(DataflowReferenceType value)

Sets the value of the dataflow property.

Parameters:

value - allowed object is DataflowReferenceType

getMetadataflow

public MetadataflowReferenceType getMetadataflow()

Gets the value of the metadataflow property.

Returns:

possible object is MetadataflowReferenceType

setMetadataflow

public void setMetadataflow(MetadataflowReferenceType value)

Sets the value of the metadataflow property.

Parameters:

value - allowed object is MetadataflowReferenceType

getReferencePeriod

public ReferencePeriodType getReferencePeriod()

Gets the value of the referencePeriod property.

Returns:

possible object is ReferencePeriodType

setReferencePeriod

public void setReferencePeriod(ReferencePeriodType value)

Sets the value of the referencePeriod property.

Parameters:

value - allowed object is ReferencePeriodType

getDataKeySetOrMetadataKeySetOrCubeRegion

public List<Object> getDataKeySetOrMetadataKeySetOrCubeRegion()

Gets the value of the dataKeySetOrMetadataKeySetOrCubeRegion property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the dataKeySetOrMetadataKeySetOrCubeRegion property.

For example, to add a new item, do as follows:

    getDataKeySetOrMetadataKeySetOrCubeRegion().add(newItem);
 

Objects of the following type(s) are allowed in the list MetadataKeySetType MetadataTargetRegionType CubeRegionType DataKeySetType

isReturnConstraints

public boolean isReturnConstraints()

Gets the value of the returnConstraints property.

Returns:

possible object is Boolean

setReturnConstraints

public void setReturnConstraints(Boolean value)

Sets the value of the returnConstraints property.

Parameters:

value - allowed object is Boolean