schemas.SDMXRegistryStructure.xsd Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdmx-sax-parser Show documentation
handcrafted sdmx parser
The newest version!



	
	
	

	
		SDMX Structure Registry Module
		The structure registry module defines the constructs that are used for the maintenance and discovery of structural metadata in a registry.
	

	
		
			SubmitStructureRequestType describes the structure of a structure submission. Structural components are provided either in-line or referenced via a SDMX-ML Structure message external to the registry. A default action and external reference resolution action are all provided for each of the contained components, but can be overridden on a per component basis.
		
		
			
				
					
						StructureLocation provides the location of a SDMX-ML Structure message, external to the repository that can be retrieved by the repository submission service.
					
				
				
					
						Structures allows for the inline definition of structural components for submission.
					
				
			
			
				
					SubmittedStructure contains a reference to one of the structural maintainable artefacts detailed in the external SDMX-ML Structure message or in-line and provides an override for the default action. This should only be used if the action to be performed on the referenced structural object is different than the default action. For example, one may want to append all structural components of a structure message, save one codelist. This codelist could be referenced in a submitted structure element and given an action of Informational.
				
			
		
		
			
				The action attribute indicates the default action (append-add, replace-update, delete, or no action-informational) to be taken on all structural components in either the external SDMX-ML Structure message or the in-line components. The default action is Append. The Replace action is not applicable to final structures in the repository, and will produce an error condition, as these can be versioned but not modified. To submit a later version of a structural object, the object should include the incremented version number.
			
		
		
			
				The externalDependencies attribute indicates the default resolution of external dependencies. This should be set to true if the repository is expected to use external reference URLs in the structural components to retrieve any externally referenced objects that is used by a non-external object.
			
		
	

	
		
			SubmittedStructureType generally references a submitted structural object. When used in a submit structure request, its purpose is to override the default action or external dependency resolution behavior. If neither of these indicators are set, then it will be ignored. In a submit structure response, it is used to reference a submitted object for the purpose of providing a status for the submission. In this case, the action attribute should be populated in order to echo the requested action.
		
		
			
		
		
			
				The action attribute will indicate the action to be taken on the referenced structural object. This should be provided when this structure is used in a submit structure response.
			
		
		
			
				The externalDependencies attribute should be set to true if the repository is expected to use external reference URLs in the structural components to retrieve objects on which the referenced object has dependencies. (Thus, if a key family referenced here is being submitted to the repository, and the structure message has URLs which point to the locations of the codelists it uses, then this attribute should be set to true). This should not be provided when this structure is used in a submit structure response.
			
		
	
	
	
		
			SubmitStructureResponseType describes the structure of a response to a structure submission. For each submitted structure, a Result will be returned.
		
		
			
				
					SubmissionResult provides a status for each submitted structural object.
				
			
		
	

	
		
			SubmissionResultType provides the status of the structural object submission request. It will identify the object submitted, report back the action requested, and convey the status and any error messages which are relevant to the submission.
		
		
			
				
					SubmittedStructure provides a reference to the submitted structural object and echoes back the action requested for it.
				
			
			
				
					StatusMessage provides that status for the submission of the structural object, and if necessary, any error or warning information.