Com::Vmware::Vapi::Metadata::Metamodel::EnumerationInfo Class Reference

Inheritance diagram for Com::Vmware::Vapi::Metadata::Metamodel::EnumerationInfo:

Avaliable Methods
public method	set_documentation ()
public method	get_documentation ()
public method	set_name ()
public method	new ()
public method	set_metadata ()
public method	get_name ()
public method	get_metadata ()
public method	set_values ()
public method	get_values ()

Detailed Description

The Com::Vmware::Vapi::Metadata::Metamodel::EnumerationInfo class contains the metamodel information of an enumeration element.

Member Function Documentation

public method Com::Vmware::Vapi::Metadata::Metamodel::EnumerationInfo::get_documentation

(

)

Gets the value of 'documentation' property.

Return values

documentation

- The current value of the field. English language documentation for an enumeration element. It can contain HTML markup and Javadoc tags. The first sentence of the enumeration documentation is a complete sentence that identifies the enumeration by name and summarizes the purpose of the enumeration. The documentation describes the context in which the enumeration is used.

The documentation also contains references to the context in which the enumeration is used. But if the enumeration is used in many contexts, the references may not be present.

String#

Code:

public method Com::Vmware::Vapi::Metadata::Metamodel::EnumerationInfo::get_metadata

(

)

Gets the value of 'metadata' property.

Return values

metadata

- The current value of the field. Generic metadata elements for an enumeration element. The key in the map is the name of the metadata element and the value is the data associated with that metadata element.

The class Com::Vmware::Vapi::Metadata::Metamodel::MetadataIdentifier contains possible string values for keys in the map .

Map#

Code:

public method Com::Vmware::Vapi::Metadata::Metamodel::EnumerationInfo::get_name

(

)

Gets the value of 'name' property.

Return values

name

- The current value of the field. Dot separated name of the enumeration element. The segments in the name reflect the organization of the APIs. The format of each segment is lower case with underscores. Each underscore represents a word boundary. If there are acronyms in the word, the capitalization is preserved. This format makes it easy to translate the segment into a different naming convention. String#

Code:

public method Com::Vmware::Vapi::Metadata::Metamodel::EnumerationInfo::get_values

(

)

Gets the value of 'values' property.

Return values

values

- The current value of the field. Metamodel information of all the enumeration value elements contained in this enumeration element. The order of the enumeration value elements in the list is same as the order in which they are defined in the interface definition file. List#

Code:

public method Com::Vmware::Vapi::Metadata::Metamodel::EnumerationInfo::new

(

)

Constructor to initialize the Com::Vmware::Vapi::Metadata::Metamodel::EnumerationInfo structure

Return values

Blessed

object

Code:

public method Com::Vmware::Vapi::Metadata::Metamodel::EnumerationInfo::set_documentation

(

)

Sets the given value for 'documentation' property.

Parameters

documentation

- New value for the field. English language documentation for an enumeration element. It can contain HTML markup and Javadoc tags. The first sentence of the enumeration documentation is a complete sentence that identifies the enumeration by name and summarizes the purpose of the enumeration. The documentation describes the context in which the enumeration is used.

The documentation also contains references to the context in which the enumeration is used. But if the enumeration is used in many contexts, the references may not be present.

Code:

public method Com::Vmware::Vapi::Metadata::Metamodel::EnumerationInfo::set_metadata

(

)

Sets the given value for 'metadata' property.

Parameters

metadata

- New value for the field. Generic metadata elements for an enumeration element. The key in the map is the name of the metadata element and the value is the data associated with that metadata element.

The class Com::Vmware::Vapi::Metadata::Metamodel::MetadataIdentifier contains possible string values for keys in the map .

Code:

public method Com::Vmware::Vapi::Metadata::Metamodel::EnumerationInfo::set_name

(

)

Sets the given value for 'name' property.

Parameters

name

- New value for the field. Dot separated name of the enumeration element. The segments in the name reflect the organization of the APIs. The format of each segment is lower case with underscores. Each underscore represents a word boundary. If there are acronyms in the word, the capitalization is preserved. This format makes it easy to translate the segment into a different naming convention.

Code:

public method Com::Vmware::Vapi::Metadata::Metamodel::EnumerationInfo::set_values

(

)

Sets the given value for 'values' property.

Parameters

values

- New value for the field. Metamodel information of all the enumeration value elements contained in this enumeration element. The order of the enumeration value elements in the list is same as the order in which they are defined in the interface definition file.

Code:

---

The documentation for this class was generated from the following file:

• Com/Vmware/Vapi/Metadata/Metamodel/EnumerationInfo.pm