org.sdmx.resources.sdmxml.schemas.v2_1.query
Enum StructureReturnDetailType

java.lang.Object
  java.lang.Enum<StructureReturnDetailType>
      org.sdmx.resources.sdmxml.schemas.v2_1.query.StructureReturnDetailType

All Implemented Interfaces:

Serializable, Comparable<StructureReturnDetailType>

public enum StructureReturnDetailType
extends Enum<StructureReturnDetailType>

Java class for StructureReturnDetailType.

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

 <simpleType name="StructureReturnDetailType">
   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
     <enumeration value="Stub"/>
     <enumeration value="CompleteStub"/>
     <enumeration value="Full"/>
     <enumeration value="MatchedItems"/>
     <enumeration value="CascadedMatchedItems"/>
   </restriction>
 </simpleType>
 

Enum Constant Summary

CASCADED_MATCHED_ITEMS
For an item scheme, only the items matching the item where parameters, and their hierarchical child items will be returned.

COMPLETE_STUB
Identification information, name, description, and annotations should be returned.

FULL
The entire detail of the object should be returned.

MATCHED_ITEMS
For an item scheme, only the items matching the item where parameters will be returned.

STUB
Only the identification information and name should be returned.

Method Summary

static StructureReturnDetailType	fromValue(String v)
String	value()
static StructureReturnDetailType	valueOf(String name) Returns the enum constant of this type with the specified name.
static StructureReturnDetailType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STUB

public static final StructureReturnDetailType STUB

Only the identification information and name should be returned.

COMPLETE_STUB

public static final StructureReturnDetailType COMPLETE_STUB

Identification information, name, description, and annotations should be returned.

FULL

public static final StructureReturnDetailType FULL

The entire detail of the object should be returned.

MATCHED_ITEMS

public static final StructureReturnDetailType MATCHED_ITEMS

For an item scheme, only the items matching the item where parameters will be returned. In the case that items are hierarchical, the entire hierarchy leading to the matched item will have to be returned.

CASCADED_MATCHED_ITEMS

public static final StructureReturnDetailType CASCADED_MATCHED_ITEMS

For an item scheme, only the items matching the item where parameters, and their hierarchical child items will be returned. In the case that items are hierarchical, the entire hierarchy leading to the matched item will have to be returned.

Method Detail

values

public static StructureReturnDetailType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (StructureReturnDetailType c : StructureReturnDetailType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static StructureReturnDetailType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

value

public String value()

fromValue

public static StructureReturnDetailType fromValue(String v)