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

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

Avaliable Methods
public method	set_documentation ()
public method	get_documentation ()
public method	set_name ()
public method	new ()
public method	set_metadata ()
public method	set_packages ()
public method	get_name ()
public method	get_metadata ()
public method	get_packages ()

Detailed Description

The Com::Vmware::Vapi::Metadata::Metamodel::ComponentInfo class contains metamodel metadata information about a component element.

Member Function Documentation

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

(

)

Gets the value of 'documentation' property.

Return values

documentation

- The current value of the field. English language documentation for a component. It can contain HTML markup and documentation tags (similar to Javadoc tags). The first sentence of the package documentation is a complete sentence that identifies the component by name and summarizes the purpose of the component. String#

Code:

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

(

)

Gets the value of 'metadata' property.

Return values

metadata

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

(

)

Gets the value of 'name' property.

Return values

name

- The current value of the field. Dot separated name of the component 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::ComponentInfo::get_packages

(

)

Gets the value of 'packages' property.

Return values

packages

- The current value of the field. Metamodel metadata information of all the package elements contained in the component element. The key in the map is the identifier of the package element and the value in the map is the metamodel information of the package element. Map#

Code:

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

(

)

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

Return values

Blessed

object

Code:

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

(

)

Sets the given value for 'documentation' property.

Parameters

documentation

- New value for the field. English language documentation for a component. It can contain HTML markup and documentation tags (similar to Javadoc tags). The first sentence of the package documentation is a complete sentence that identifies the component by name and summarizes the purpose of the component.

Code:

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

(

)

Sets the given value for 'metadata' property.

Parameters

metadata

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

(

)

Sets the given value for 'name' property.

Parameters

name

- New value for the field. Dot separated name of the component 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::ComponentInfo::set_packages

(

)

Sets the given value for 'packages' property.

Parameters

packages

- New value for the field. Metamodel metadata information of all the package elements contained in the component element. The key in the map is the identifier of the package element and the value in the map is the metamodel information of the package element.

Code:

---

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

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