OrganisationSchemeType (sdmx-model-2

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.structure
Class OrganisationSchemeType

java.lang.Object
  org.sdmx.resources.sdmxml.schemas.v2_0.structure.OrganisationSchemeType

public class OrganisationSchemeType
extends Object
extends Object

OrganisationSchemeType contains the details of an OrganisationScheme. In OrganisationSchemes, the organisation roles of agency, data provider, and data consumer may be specified. A single organisation may play more than one role. Name is an element which provides for a human-readable name for the organization. Description may be used to provide a longer, human-readable description. the is attribute provides a formal ID for the organisation scheme; the version attribute specifies a particular version. If blank, it is assumed that the version is "1.0". The uri attributre specifies the location of a valid SDMC Structure Message containing the full details of the organisation sc`heme, and is required if the isExternalReference attribute has a value of true. If isExternalReference has a value of false, full details must be provided in the current instance of the OrganisationScheme element. The urn attribute provides a formal SDMX Registry URL - see the Logical Registry Specification for specific requirements. An agencyID must be provided, identifying the maintenance agency of the organisation scheme. Also, if the organisation scheme is final, the isFinal attribute must have a value of true - otherwise, it will be assumed to be non-final. (All production schemes must be made final - that is, unchangeable without versioning.) The validFrom and validTo attributes provide inclusive dates for providing supplemental validity information about the version.

Java class for OrganisationSchemeType complex type.

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

 <complexType name="OrganisationSchemeType">
   <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"/>
         <element name="Description" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}TextType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Agencies" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}AgenciesType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="DataProviders" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}DataProvidersType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="DataConsumers" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}DataConsumersType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Annotations" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}AnnotationsType" minOccurs="0"/>
       </sequence>
       <attribute name="id" use="required" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
       <attribute name="version" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="uri" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
       <attribute name="urn" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
       <attribute name="isExternalReference" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="agencyID" use="required" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
       <attribute name="isFinal" 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 List<AgenciesType>`	`agencies`
`protected String`	`agencyID`
`protected AnnotationsType`	`annotations`
`protected List<DataConsumersType>`	`dataConsumers`
`protected List<DataProvidersType>`	`dataProviders`
`protected List<TextType>`	`description`
`protected String`	`id`
`protected Boolean`	`isExternalReference`
`protected Boolean`	`isFinal`
`protected List<TextType>`	`name`
`protected String`	`uri`
`protected String`	`urn`
`protected String`	`validFrom`
`protected String`	`validTo`
`protected String`	`version`

Constructor Summary
`OrganisationSchemeType()`

Method Summary
`List<AgenciesType>`	`getAgencies()` Gets the value of the agencies property.
`String`	`getAgencyID()` Gets the value of the agencyID property.
`AnnotationsType`	`getAnnotations()` Gets the value of the annotations property.
`List<DataConsumersType>`	`getDataConsumers()` Gets the value of the dataConsumers property.
`List<DataProvidersType>`	`getDataProviders()` Gets the value of the dataProviders property.
`List<TextType>`	`getDescription()` Gets the value of the description property.
`String`	`getId()` Gets the value of the id 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.
`String`	`getVersion()` Gets the value of the version property.
`Boolean`	`isIsExternalReference()` Gets the value of the isExternalReference property.
`Boolean`	`isIsFinal()` Gets the value of the isFinal property.
`void`	`setAgencyID(String value)` Sets the value of the agencyID property.
`void`	`setAnnotations(AnnotationsType value)` Sets the value of the annotations property.
`void`	`setId(String value)` Sets the value of the id property.
`void`	`setIsExternalReference(Boolean value)` Sets the value of the isExternalReference property.
`void`	`setIsFinal(Boolean value)` Sets the value of the isFinal 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.
`void`	`setVersion(String value)` Sets the value of the version 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

agencies

protected List<AgenciesType> agencies

dataProviders

protected List<DataProvidersType> dataProviders

dataConsumers

protected List<DataConsumersType> dataConsumers

annotations

protected AnnotationsType annotations

id

protected String id

version

protected String version

uri

protected String uri

urn

protected String urn

isExternalReference

protected Boolean isExternalReference

agencyID

protected String agencyID

isFinal

protected Boolean isFinal

validFrom

protected String validFrom

validTo

protected String validTo

Constructor Detail

OrganisationSchemeType

public OrganisationSchemeType()

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.