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

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

Avaliable Methods
public method	set_documentation ()
public method	set_type ()
public method	get_documentation ()
public method	get_type ()
public method	set_name ()
public method	new ()
public method	set_metadata ()
public method	get_name ()
public method	get_metadata ()

Detailed Description

The Com::Vmware::Vapi::Metadata::Metamodel::FieldInfo class contains metamodel information of a field element contained in a structure element.

Member Function Documentation

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

(

)

Gets the value of 'documentation' property.

Return values

documentation

- The current value of the field. English language documentation for the service element. It can contain HTML markup and Javadoc tags. String#

Code:

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

(

)

Gets the value of 'metadata' property.

Return values

metadata

- The current value of the field. Generic metadata elements for the field 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::FieldInfo::get_name

(

)

Gets the value of 'name' property.

Return values

name

- The current value of the field. Name of the field element in a canonical format. The format 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::FieldInfo::get_type

(

)

Gets the value of 'type' property.

Return values

type	- The current value of the field. Type information. Type#

Code:

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

(

)

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

Return values

Blessed

object

Code:

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

(

)

Sets the given value for 'documentation' property.

Parameters

documentation

- New value for the field. English language documentation for the service element. It can contain HTML markup and Javadoc tags.

Code:

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

(

)

Sets the given value for 'metadata' property.

Parameters

metadata

- New value for the field. Generic metadata elements for the field 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::FieldInfo::set_name

(

)

Sets the given value for 'name' property.

Parameters

name

- New value for the field. Name of the field element in a canonical format. The format 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::FieldInfo::set_type

(

)

Sets the given value for 'type' property.

Parameters

type	- New value for the field. Type information.

Code:

---

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

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