Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.sdmx.resources.sdmxml.schemas.v2_0.registry
Class ProvisionAgreementType

java.lang.Object
  extended by org.sdmx.resources.sdmxml.schemas.v2_0.registry.ProvisionAgreementType

public class ProvisionAgreementType
extends Object

Provision agreements contain a reference to a pre-existing data flow or metadata flow definition and a pre-existing data (or metadata) provider in the registry. They also must have the action attribute set, indicating whether this is an addition, a modification, or a deletion of a provision agreement. They may also supply boolean values which describe how the registry must behave: if indexTimeSeries is true, then the registry must index all time series when a data set is registered against this provision agreement; if indexDataSet is true, then the registry must index the range of actual (present) values for each dimension of the Dataset (as indicated in the dataset's key family); if indexReportingPeriod is true, then the registry must index the time period ranges for which data are present in the dataset(s) registered against the provision agreement. Note that the values for these attributes are not needed when a Delete action is indicated. As for all identifiable objects, provision agreements have Name and Description elements, which are repeatable to provide language-specific forms. These may be ommitted if the provision agreement already exists (as is the case for modification and deletion); descriptions are always optional. The id attribute holds the unique id of the provision agreement as derived (according to teh logical registry specifcation.) If specified, the uri attribute points to a location (typically a URL) where the provision agreement is described in a valid QueryProvisioningResponse message. The urn attribute holds the reserved registry URN assigned to the provision agreement - this must be included when the ProvisionAgreement structure is used in a response document of any type. The action attribute must be specified when the provisionAgreement is used in a request document of any type.. Datasource is used to describe the data source associated with the provider agreement. Annotations may be provided in the Annotations element. The validFrom and validTo attributes provide inclusive dates for providing supplemental validity information about the version.

Java class for ProvisionAgreementType complex type.

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

 <complexType name="ProvisionAgreementType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="Name" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}TextType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Description" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}TextType" maxOccurs="unbounded" minOccurs="0"/>
         <choice>
           <element name="DataflowRef" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/registry}DataflowRefType"/>
           <element name="MetadataflowRef" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/registry}MetadataflowRefType"/>
         </choice>
         <element name="DataProviderRef" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/registry}DataProviderRefType"/>
         <element name="Datasource" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/registry}QueryableDatasourceType" minOccurs="0"/>
         <element name="Constraint" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}ConstraintType" minOccurs="0"/>
         <element name="Annotations" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}AnnotationsType" minOccurs="0"/>
       </sequence>
       <attribute name="id" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
       <attribute name="uri" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
       <attribute name="urn" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
       <attribute name="action" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}ActionType" />
       <attribute name="indexTimeSeries" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="indexDataSet" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="indexReportingPeriod" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="validFrom" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}TimePeriodType" />
       <attribute name="validTo" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}TimePeriodType" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary
protected  ActionType action
           
protected  AnnotationsType annotations
           
protected  ConstraintType constraint
           
protected  DataflowRefType dataflowRef
           
protected  DataProviderRefType dataProviderRef
           
protected  QueryableDatasourceType datasource
           
protected  List<TextType> description
           
protected  String id
           
protected  Boolean indexDataSet
           
protected  Boolean indexReportingPeriod
           
protected  Boolean indexTimeSeries
           
protected  MetadataflowRefType metadataflowRef
           
protected  List<TextType> name
           
protected  String uri
           
protected  String urn
           
protected  String validFrom
           
protected  String validTo
           
 
Constructor Summary
ProvisionAgreementType()
           
 
Method Summary
 ActionType getAction()
          Gets the value of the action property.
 AnnotationsType getAnnotations()
          Gets the value of the annotations property.
 ConstraintType getConstraint()
          Gets the value of the constraint property.
 DataflowRefType getDataflowRef()
          Gets the value of the dataflowRef property.
 DataProviderRefType getDataProviderRef()
          Gets the value of the dataProviderRef property.
 QueryableDatasourceType getDatasource()
          Gets the value of the datasource property.
 List<TextType> getDescription()
          Gets the value of the description property.
 String getId()
          Gets the value of the id property.
 MetadataflowRefType getMetadataflowRef()
          Gets the value of the metadataflowRef property.
 List<TextType> getName()
          Gets the value of the name property.
 String getUri()
          Gets the value of the uri property.
 String getUrn()
          Gets the value of the urn property.
 String getValidFrom()
          Gets the value of the validFrom property.
 String getValidTo()
          Gets the value of the validTo property.
 Boolean isIndexDataSet()
          Gets the value of the indexDataSet property.
 Boolean isIndexReportingPeriod()
          Gets the value of the indexReportingPeriod property.
 Boolean isIndexTimeSeries()
          Gets the value of the indexTimeSeries property.
 void setAction(ActionType value)
          Sets the value of the action property.
 void setAnnotations(AnnotationsType value)
          Sets the value of the annotations property.
 void setConstraint(ConstraintType value)
          Sets the value of the constraint property.
 void setDataflowRef(DataflowRefType value)
          Sets the value of the dataflowRef property.
 void setDataProviderRef(DataProviderRefType value)
          Sets the value of the dataProviderRef property.
 void setDatasource(QueryableDatasourceType value)
          Sets the value of the datasource property.
 void setId(String value)
          Sets the value of the id property.
 void setIndexDataSet(Boolean value)
          Sets the value of the indexDataSet property.
 void setIndexReportingPeriod(Boolean value)
          Sets the value of the indexReportingPeriod property.
 void setIndexTimeSeries(Boolean value)
          Sets the value of the indexTimeSeries property.
 void setMetadataflowRef(MetadataflowRefType value)
          Sets the value of the metadataflowRef property.
 void setUri(String value)
          Sets the value of the uri property.
 void setUrn(String value)
          Sets the value of the urn property.
 void setValidFrom(String value)
          Sets the value of the validFrom property.
 void setValidTo(String value)
          Sets the value of the validTo property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

name

protected List<TextType> name

description

protected List<TextType> description

dataflowRef

protected DataflowRefType dataflowRef

metadataflowRef

protected MetadataflowRefType metadataflowRef

dataProviderRef

protected DataProviderRefType dataProviderRef

datasource

protected QueryableDatasourceType datasource

constraint

protected ConstraintType constraint

annotations

protected AnnotationsType annotations

id

protected String id

uri

protected String uri

urn

protected String urn

action

protected ActionType action

indexTimeSeries

protected Boolean indexTimeSeries

indexDataSet

protected Boolean indexDataSet

indexReportingPeriod

protected Boolean indexReportingPeriod

validFrom

protected String validFrom

validTo

protected String validTo
Constructor Detail

ProvisionAgreementType

public ProvisionAgreementType()
Method Detail

getName

public List<TextType> getName()
Gets the value of the name 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 name property.

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

    getName().add(newItem);

Objects of the following type(s) are allowed in the list TextType

getDescription

public List<TextType> getDescription()
Gets the value of the description 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 description property.

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

    getDescription().add(newItem);

Objects of the following type(s) are allowed in the list TextType

getDataflowRef

public DataflowRefType getDataflowRef()
Gets the value of the dataflowRef property.

Returns:
possible object is DataflowRefType

setDataflowRef

public void setDataflowRef(DataflowRefType value)
Sets the value of the dataflowRef property.

Parameters:
value - allowed object is DataflowRefType

getMetadataflowRef

public MetadataflowRefType getMetadataflowRef()
Gets the value of the metadataflowRef property.

Returns:
possible object is MetadataflowRefType

setMetadataflowRef

public void setMetadataflowRef(MetadataflowRefType value)
Sets the value of the metadataflowRef property.

Parameters:
value - allowed object is MetadataflowRefType

getDataProviderRef

public DataProviderRefType getDataProviderRef()
Gets the value of the dataProviderRef property.

Returns:
possible object is DataProviderRefType

setDataProviderRef

public void setDataProviderRef(DataProviderRefType value)
Sets the value of the dataProviderRef property.

Parameters:
value - allowed object is DataProviderRefType

getDatasource

public QueryableDatasourceType getDatasource()
Gets the value of the datasource property.

Returns:
possible object is QueryableDatasourceType

setDatasource

public void setDatasource(QueryableDatasourceType value)
Sets the value of the datasource property.

Parameters:
value - allowed object is QueryableDatasourceType

getConstraint

public ConstraintType getConstraint()
Gets the value of the constraint property.

Returns:
possible object is ConstraintType

setConstraint

public void setConstraint(ConstraintType value)
Sets the value of the constraint property.

Parameters:
value - allowed object is ConstraintType

getAnnotations

public AnnotationsType getAnnotations()
Gets the value of the annotations property.

Returns:
possible object is AnnotationsType

setAnnotations

public void setAnnotations(AnnotationsType value)
Sets the value of the annotations property.

Parameters:
value - allowed object is AnnotationsType

getId

public String getId()
Gets the value of the id property.

Returns:
possible object is String

setId

public void setId(String value)
Sets the value of the id property.

Parameters:
value - allowed object is String

getUri

public String getUri()
Gets the value of the uri property.

Returns:
possible object is String

setUri

public void setUri(String value)
Sets the value of the uri property.

Parameters:
value - allowed object is String

getUrn

public String getUrn()
Gets the value of the urn property.

Returns:
possible object is String

setUrn

public void setUrn(String value)
Sets the value of the urn property.

Parameters:
value - allowed object is String

getAction

public ActionType getAction()
Gets the value of the action property.

Returns:
possible object is ActionType

setAction

public void setAction(ActionType value)
Sets the value of the action property.

Parameters:
value - allowed object is ActionType

isIndexTimeSeries

public Boolean isIndexTimeSeries()
Gets the value of the indexTimeSeries property.

Returns:
possible object is Boolean

setIndexTimeSeries

public void setIndexTimeSeries(Boolean value)
Sets the value of the indexTimeSeries property.

Parameters:
value - allowed object is Boolean

isIndexDataSet

public Boolean isIndexDataSet()
Gets the value of the indexDataSet property.

Returns:
possible object is Boolean

setIndexDataSet

public void setIndexDataSet(Boolean value)
Sets the value of the indexDataSet property.

Parameters:
value - allowed object is Boolean

isIndexReportingPeriod

public Boolean isIndexReportingPeriod()
Gets the value of the indexReportingPeriod property.

Returns:
possible object is Boolean

setIndexReportingPeriod

public void setIndexReportingPeriod(Boolean value)
Sets the value of the indexReportingPeriod property.

Parameters:
value - allowed object is Boolean

getValidFrom

public String getValidFrom()
Gets the value of the validFrom property.

Returns:
possible object is String

setValidFrom

public void setValidFrom(String value)
Sets the value of the validFrom property.

Parameters:
value - allowed object is String

getValidTo

public String getValidTo()
Gets the value of the validTo property.

Returns:
possible object is String

setValidTo

public void setValidTo(String value)
Sets the value of the validTo property.

Parameters:
value - allowed object is String
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2012. All Rights Reserved.