org.dmtf.schemas.ovf.envelope
Interface EnvelopeType

All Superinterfaces:
EObject, Notifier

public interface EnvelopeType
extends EObject

A representation of the model object 'Type'. Root OVF descriptor type

The following features are supported:

See Also:
EnvelopePackage.getEnvelopeType()

Method Summary
 EList<EnvironmentType> createEnvironments()
           
 EList<SectionType> getAllSections()
          Deprecated. You probably want to use getSection()
 FeatureMap getAny()
          Returns the value of the 'Any' attribute list.
 FeatureMap getAnyAttribute()
          Returns the value of the 'Any Attribute' attribute list.
 ContentType getContent()
          Returns the value of the 'Content' containment reference.
 FeatureMap getContentGroup()
          Returns the value of the 'Content Group' attribute list.
 DeploymentOptionSectionType getDeploymentOptions()
          Returns the value of the 'Deployment Options' reference.
 DiskSectionType getDiskSection()
          Returns the value of the 'Disk Section' reference.
 java.lang.String getLang()
          Returns the value of the 'Lang' attribute.
 NetworkSectionType getNetworkSection()
          Returns the value of the 'Network Section' reference.
 ReferencesType getReferences()
          Returns the value of the 'References' containment reference.
 EList<SectionType> getSection()
          Returns the value of the 'Section' containment reference list.
 FeatureMap getSectionGroup()
          Returns the value of the 'Section Group' attribute list.
 EList<StringsType> getStrings()
          Returns the value of the 'Strings' containment reference list.
 VirtualSystemType getVirtualSystem()
          Returns the value of the 'Virtual System' reference.
 VirtualSystemType getVirtualSystem(java.lang.String vmId)
          Locates a virtual system with a given id in the descriptor.
 VirtualSystemCollectionType getVirtualSystemCollection()
          Returns the value of the 'Virtual System Collection' reference.
 void setContent(ContentType value)
          Sets the value of the 'Content' containment reference.
 void setDeploymentOptions(DeploymentOptionSectionType value)
          Sets the value of the 'Deployment Options' reference.
 void setDiskSection(DiskSectionType value)
          Sets the value of the 'Disk Section' reference.
 void setLang(java.lang.String value)
          Sets the value of the 'Lang' attribute.
 void setNetworkSection(NetworkSectionType value)
          Sets the value of the 'Network Section' reference.
 void setReferences(ReferencesType value)
          Sets the value of the 'References' containment reference.
 void setVirtualSystem(VirtualSystemType value)
          Sets the value of the 'Virtual System' reference.
 void setVirtualSystemCollection(VirtualSystemCollectionType value)
          Sets the value of the 'Virtual System Collection' reference.
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

getReferences

ReferencesType getReferences()
Returns the value of the 'References' containment reference. It is bidirectional and its opposite is 'Envelope'. References to all external files

Returns:
the value of the 'References' containment reference.
See Also:
setReferences(ReferencesType), EnvelopePackage.getEnvelopeType_References(), ReferencesType.getEnvelope()

setReferences

void setReferences(ReferencesType value)
Sets the value of the 'References' containment reference.

Parameters:
value - the new value of the 'References' containment reference.
See Also:
getReferences()

getSectionGroup

FeatureMap getSectionGroup()
Returns the value of the 'Section Group' attribute list. The list contents are of type FeatureMap.Entry. Package level meta-data

Returns:
the value of the 'Section Group' attribute list.
See Also:
EnvelopePackage.getEnvelopeType_SectionGroup()

getSection

EList<SectionType> getSection()
Returns the value of the 'Section' containment reference list. The list contents are of type SectionType. Package level meta-data

Returns:
the value of the 'Section' containment reference list.
See Also:
EnvelopePackage.getEnvelopeType_Section()

getContentGroup

FeatureMap getContentGroup()
Returns the value of the 'Content Group' attribute list. The list contents are of type FeatureMap.Entry. Content: A VirtualSystem or a VirtualSystemCollection

Returns:
the value of the 'Content Group' attribute list.
See Also:
EnvelopePackage.getEnvelopeType_ContentGroup()

getContent

ContentType getContent()
Returns the value of the 'Content' containment reference. It is bidirectional and its opposite is 'Envelope'. Content: A VirtualSystem or a VirtualSystemCollection

Returns:
the value of the 'Content' containment reference.
See Also:
setContent(ContentType), EnvelopePackage.getEnvelopeType_Content(), ContentType.getEnvelope()

setContent

void setContent(ContentType value)
Sets the value of the 'Content' containment reference.

Parameters:
value - the new value of the 'Content' containment reference.
See Also:
getContent()

getStrings

EList<StringsType> getStrings()
Returns the value of the 'Strings' containment reference list. The list contents are of type StringsType. It is bidirectional and its opposite is 'Envelope'. Localized string resource bundles

Returns:
the value of the 'Strings' containment reference list.
See Also:
EnvelopePackage.getEnvelopeType_Strings(), StringsType.getEnvelope()

getAny

FeatureMap getAny()
Returns the value of the 'Any' attribute list. The list contents are of type FeatureMap.Entry.

If the meaning of the 'Any' attribute list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Any' attribute list.
See Also:
EnvelopePackage.getEnvelopeType_Any()

getAnyAttribute

FeatureMap getAnyAttribute()
Returns the value of the 'Any Attribute' attribute list. The list contents are of type FeatureMap.Entry.

If the meaning of the 'Any Attribute' attribute list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Any Attribute' attribute list.
See Also:
EnvelopePackage.getEnvelopeType_AnyAttribute()

getAllSections

EList<SectionType> getAllSections()
Deprecated. You probably want to use getSection()

Returns all the sections in the descriptor, regardless of whether or not they are defined with substitution groups.


getVirtualSystem

VirtualSystemType getVirtualSystem(java.lang.String vmId)
Locates a virtual system with a given id in the descriptor. Return null if not found


createEnvironments

EList<EnvironmentType> createEnvironments()


getDiskSection

DiskSectionType getDiskSection()
Returns the value of the 'Disk Section' reference.

If the meaning of the 'Disk Section' reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Disk Section' reference.
See Also:
setDiskSection(DiskSectionType), EnvelopePackage.getEnvelopeType_DiskSection()

setDiskSection

void setDiskSection(DiskSectionType value)
Sets the value of the 'Disk Section' reference.

Parameters:
value - the new value of the 'Disk Section' reference.
See Also:
getDiskSection()

getLang

java.lang.String getLang()
Returns the value of the 'Lang' attribute.

lang (as an attribute name)

denotes an attribute whose value is a language code for the natural language of the content of any element; its value is inherited. This name is reserved by virtue of its definition in the XML specification.

Notes

Attempting to install the relevant ISO 2- and 3-letter codes as the enumerated possible values is probably never going to be a realistic possibility.

See BCP 47 at http://www.rfc-editor.org/rfc/bcp/bcp47.txt and the IANA language subtag registry at http://www.iana.org/assignments/language-subtag-registry for further information.

The union allows for the 'un-declaration' of xml:lang with the empty string.

Returns:
the value of the 'Lang' attribute.
See Also:
setLang(String), EnvelopePackage.getEnvelopeType_Lang()

setLang

void setLang(java.lang.String value)
Sets the value of the 'Lang' attribute.

Parameters:
value - the new value of the 'Lang' attribute.
See Also:
getLang()

getNetworkSection

NetworkSectionType getNetworkSection()
Returns the value of the 'Network Section' reference.

If the meaning of the 'Network Section' reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Network Section' reference.
See Also:
setNetworkSection(NetworkSectionType), EnvelopePackage.getEnvelopeType_NetworkSection()

setNetworkSection

void setNetworkSection(NetworkSectionType value)
Sets the value of the 'Network Section' reference.

Parameters:
value - the new value of the 'Network Section' reference.
See Also:
getNetworkSection()

getVirtualSystem

VirtualSystemType getVirtualSystem()
Returns the value of the 'Virtual System' reference.

If the meaning of the 'Virtual System' reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Virtual System' reference.
See Also:
setVirtualSystem(VirtualSystemType), EnvelopePackage.getEnvelopeType_VirtualSystem()

setVirtualSystem

void setVirtualSystem(VirtualSystemType value)
Sets the value of the 'Virtual System' reference.

Parameters:
value - the new value of the 'Virtual System' reference.
See Also:
getVirtualSystem()

getVirtualSystemCollection

VirtualSystemCollectionType getVirtualSystemCollection()
Returns the value of the 'Virtual System Collection' reference.

If the meaning of the 'Virtual System Collection' reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Virtual System Collection' reference.
See Also:
setVirtualSystemCollection(VirtualSystemCollectionType), EnvelopePackage.getEnvelopeType_VirtualSystemCollection()

setVirtualSystemCollection

void setVirtualSystemCollection(VirtualSystemCollectionType value)
Sets the value of the 'Virtual System Collection' reference.

Parameters:
value - the new value of the 'Virtual System Collection' reference.
See Also:
getVirtualSystemCollection()

getDeploymentOptions

DeploymentOptionSectionType getDeploymentOptions()
Returns the value of the 'Deployment Options' reference.

If the meaning of the 'Deployment Options' reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Deployment Options' reference.
See Also:
setDeploymentOptions(DeploymentOptionSectionType), EnvelopePackage.getEnvelopeType_DeploymentOptions()

setDeploymentOptions

void setDeploymentOptions(DeploymentOptionSectionType value)
Sets the value of the 'Deployment Options' reference.

Parameters:
value - the new value of the 'Deployment Options' reference.
See Also:
getDeploymentOptions()


© Copyright 2008 IBM Corp. 2008 All Rights Reserved