org.dmtf.schemas.ovf.envelope
Interface DocumentRoot

All Superinterfaces:
EObject, Notifier

public interface DocumentRoot
extends EObject

A representation of the model object 'Document Root'.

The following features are supported:

See Also:
EnvelopePackage.getDocumentRoot()

Method Summary
 AnnotationSectionType getAnnotationSection()
          Returns the value of the 'Annotation Section' containment reference.
 ContentType getContent()
          Returns the value of the 'Content' containment reference.
 DeploymentOptionSectionType getDeploymentOptionSection()
          Returns the value of the 'Deployment Option Section' containment reference.
 DiskSectionType getDiskSection()
          Returns the value of the 'Disk Section' containment reference.
 EnvelopeType getEnvelope()
          Returns the value of the 'Envelope' containment reference.
 EulaSectionType getEulaSection()
          Returns the value of the 'Eula Section' containment reference.
 InstallSectionType getInstallSection()
          Returns the value of the 'Install Section' containment reference.
 FeatureMap getMixed()
          Returns the value of the 'Mixed' attribute list.
 NetworkSectionType getNetworkSection()
          Returns the value of the 'Network Section' containment reference.
 OperatingSystemSectionType getOperatingSystemSection()
          Returns the value of the 'Operating System Section' containment reference.
 ProductSectionType getProductSection()
          Returns the value of the 'Product Section' containment reference.
 ResourceAllocationSectionType getResourceAllocationSection()
          Returns the value of the 'Resource Allocation Section' containment reference.
 SectionType getSection()
          Returns the value of the 'Section' containment reference.
 StartupSectionType getStartupSection()
          Returns the value of the 'Startup Section' containment reference.
 StringsType getStrings()
          Returns the value of the 'Strings' containment reference.
 VirtualHardwareSectionType getVirtualHardwareSection()
          Returns the value of the 'Virtual Hardware Section' containment reference.
 VirtualSystemType getVirtualSystem()
          Returns the value of the 'Virtual System' containment reference.
 VirtualSystemCollectionType getVirtualSystemCollection()
          Returns the value of the 'Virtual System Collection' containment reference.
 EMap<java.lang.String,java.lang.String> getXMLNSPrefixMap()
          Returns the value of the 'XMLNS Prefix Map' map.
 EMap<java.lang.String,java.lang.String> getXSISchemaLocation()
          Returns the value of the 'XSI Schema Location' map.
 boolean isRequired()
          Returns the value of the 'Required' attribute.
 boolean isSetRequired()
          Returns whether the value of the 'Required' attribute is set.
 void setAnnotationSection(AnnotationSectionType value)
          Sets the value of the 'Annotation Section' containment reference.
 void setContent(ContentType value)
          Sets the value of the 'Content' containment reference.
 void setDeploymentOptionSection(DeploymentOptionSectionType value)
          Sets the value of the 'Deployment Option Section' containment reference.
 void setDiskSection(DiskSectionType value)
          Sets the value of the 'Disk Section' containment reference.
 void setEnvelope(EnvelopeType value)
          Sets the value of the 'Envelope' containment reference.
 void setEulaSection(EulaSectionType value)
          Sets the value of the 'Eula Section' containment reference.
 void setInstallSection(InstallSectionType value)
          Sets the value of the 'Install Section' containment reference.
 void setNetworkSection(NetworkSectionType value)
          Sets the value of the 'Network Section' containment reference.
 void setOperatingSystemSection(OperatingSystemSectionType value)
          Sets the value of the 'Operating System Section' containment reference.
 void setProductSection(ProductSectionType value)
          Sets the value of the 'Product Section' containment reference.
 void setRequired(boolean value)
          Sets the value of the 'Required' attribute.
 void setResourceAllocationSection(ResourceAllocationSectionType value)
          Sets the value of the 'Resource Allocation Section' containment reference.
 void setSection(SectionType value)
          Sets the value of the 'Section' containment reference.
 void setStartupSection(StartupSectionType value)
          Sets the value of the 'Startup Section' containment reference.
 void setStrings(StringsType value)
          Sets the value of the 'Strings' containment reference.
 void setVirtualHardwareSection(VirtualHardwareSectionType value)
          Sets the value of the 'Virtual Hardware Section' containment reference.
 void setVirtualSystem(VirtualSystemType value)
          Sets the value of the 'Virtual System' containment reference.
 void setVirtualSystemCollection(VirtualSystemCollectionType value)
          Sets the value of the 'Virtual System Collection' containment reference.
 void unsetRequired()
          Unsets the value of the 'Required' attribute.
 
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

getMixed

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

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

Returns:
the value of the 'Mixed' attribute list.
See Also:
EnvelopePackage.getDocumentRoot_Mixed()

getXMLNSPrefixMap

EMap<java.lang.String,java.lang.String> getXMLNSPrefixMap()
Returns the value of the 'XMLNS Prefix Map' map. The key is of type String, and the value is of type String,

If the meaning of the 'XMLNS Prefix Map' map isn't clear, there really should be more of a description here...

Returns:
the value of the 'XMLNS Prefix Map' map.
See Also:
EnvelopePackage.getDocumentRoot_XMLNSPrefixMap()

getXSISchemaLocation

EMap<java.lang.String,java.lang.String> getXSISchemaLocation()
Returns the value of the 'XSI Schema Location' map. The key is of type String, and the value is of type String,

If the meaning of the 'XSI Schema Location' map isn't clear, there really should be more of a description here...

Returns:
the value of the 'XSI Schema Location' map.
See Also:
EnvelopePackage.getDocumentRoot_XSISchemaLocation()

getAnnotationSection

AnnotationSectionType getAnnotationSection()
Returns the value of the 'Annotation Section' containment reference. Element substitutable for Section since AnnotationSection_Type is a derivation of Section_Type

Returns:
the value of the 'Annotation Section' containment reference.
See Also:
setAnnotationSection(AnnotationSectionType), EnvelopePackage.getDocumentRoot_AnnotationSection()

setAnnotationSection

void setAnnotationSection(AnnotationSectionType value)
Sets the value of the 'Annotation Section' containment reference.

Parameters:
value - the new value of the 'Annotation Section' containment reference.
See Also:
getAnnotationSection()

getSection

SectionType getSection()
Returns the value of the 'Section' containment reference. Base elements for OVF sections. This is the head of the substitution group.

Returns:
the value of the 'Section' containment reference.
See Also:
setSection(SectionType), EnvelopePackage.getDocumentRoot_Section()

setSection

void setSection(SectionType value)
Sets the value of the 'Section' containment reference.

Parameters:
value - the new value of the 'Section' containment reference.
See Also:
getSection()

getContent

ContentType getContent()
Returns the value of the 'Content' containment reference. Base element for content types. This is the head the subsitution group

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

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()

getDeploymentOptionSection

DeploymentOptionSectionType getDeploymentOptionSection()
Returns the value of the 'Deployment Option Section' containment reference. Element substitutable for Section since DeploymentOptionSection_Type is a derivation of Section_Type

Returns:
the value of the 'Deployment Option Section' containment reference.
See Also:
setDeploymentOptionSection(DeploymentOptionSectionType), EnvelopePackage.getDocumentRoot_DeploymentOptionSection()

setDeploymentOptionSection

void setDeploymentOptionSection(DeploymentOptionSectionType value)
Sets the value of the 'Deployment Option Section' containment reference.

Parameters:
value - the new value of the 'Deployment Option Section' containment reference.
See Also:
getDeploymentOptionSection()

getDiskSection

DiskSectionType getDiskSection()
Returns the value of the 'Disk Section' containment reference. Element substitutable for Section since DiskSection_Type is a derivation of Section_Type

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

setDiskSection

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

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

getEnvelope

EnvelopeType getEnvelope()
Returns the value of the 'Envelope' containment reference. Root element of OVF Descriptor

Returns:
the value of the 'Envelope' containment reference.
See Also:
setEnvelope(EnvelopeType), EnvelopePackage.getDocumentRoot_Envelope()

setEnvelope

void setEnvelope(EnvelopeType value)
Sets the value of the 'Envelope' containment reference.

Parameters:
value - the new value of the 'Envelope' containment reference.
See Also:
getEnvelope()

getEulaSection

EulaSectionType getEulaSection()
Returns the value of the 'Eula Section' containment reference. Element substitutable for Section since EulaSection_Type is a derivation of Section_Type

Returns:
the value of the 'Eula Section' containment reference.
See Also:
setEulaSection(EulaSectionType), EnvelopePackage.getDocumentRoot_EulaSection()

setEulaSection

void setEulaSection(EulaSectionType value)
Sets the value of the 'Eula Section' containment reference.

Parameters:
value - the new value of the 'Eula Section' containment reference.
See Also:
getEulaSection()

getInstallSection

InstallSectionType getInstallSection()
Returns the value of the 'Install Section' containment reference. Element substitutable for Section since InstallSection_Type is a derivation of Section_Type

Returns:
the value of the 'Install Section' containment reference.
See Also:
setInstallSection(InstallSectionType), EnvelopePackage.getDocumentRoot_InstallSection()

setInstallSection

void setInstallSection(InstallSectionType value)
Sets the value of the 'Install Section' containment reference.

Parameters:
value - the new value of the 'Install Section' containment reference.
See Also:
getInstallSection()

getNetworkSection

NetworkSectionType getNetworkSection()
Returns the value of the 'Network Section' containment reference. Element substitutable for Section since NetworkSection_Type is a derivation of Section_Type

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

setNetworkSection

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

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

getOperatingSystemSection

OperatingSystemSectionType getOperatingSystemSection()
Returns the value of the 'Operating System Section' containment reference. Element substitutable for Section since OperatingSystemSection_Type is a derivation of Section_Type

Returns:
the value of the 'Operating System Section' containment reference.
See Also:
setOperatingSystemSection(OperatingSystemSectionType), EnvelopePackage.getDocumentRoot_OperatingSystemSection()

setOperatingSystemSection

void setOperatingSystemSection(OperatingSystemSectionType value)
Sets the value of the 'Operating System Section' containment reference.

Parameters:
value - the new value of the 'Operating System Section' containment reference.
See Also:
getOperatingSystemSection()

getProductSection

ProductSectionType getProductSection()
Returns the value of the 'Product Section' containment reference. Element substitutable for Section since ProductSection_Type is a derivation of Section_Type

Returns:
the value of the 'Product Section' containment reference.
See Also:
setProductSection(ProductSectionType), EnvelopePackage.getDocumentRoot_ProductSection()

setProductSection

void setProductSection(ProductSectionType value)
Sets the value of the 'Product Section' containment reference.

Parameters:
value - the new value of the 'Product Section' containment reference.
See Also:
getProductSection()

getResourceAllocationSection

ResourceAllocationSectionType getResourceAllocationSection()
Returns the value of the 'Resource Allocation Section' containment reference. Element substitutable for Section since ResourceAllocationSection_Type is a derivation of Section_Type

Returns:
the value of the 'Resource Allocation Section' containment reference.
See Also:
setResourceAllocationSection(ResourceAllocationSectionType), EnvelopePackage.getDocumentRoot_ResourceAllocationSection()

setResourceAllocationSection

void setResourceAllocationSection(ResourceAllocationSectionType value)
Sets the value of the 'Resource Allocation Section' containment reference.

Parameters:
value - the new value of the 'Resource Allocation Section' containment reference.
See Also:
getResourceAllocationSection()

getStartupSection

StartupSectionType getStartupSection()
Returns the value of the 'Startup Section' containment reference. Element substitutable for Section since StartupSection_Type is a derivation of Section_Type

Returns:
the value of the 'Startup Section' containment reference.
See Also:
setStartupSection(StartupSectionType), EnvelopePackage.getDocumentRoot_StartupSection()

setStartupSection

void setStartupSection(StartupSectionType value)
Sets the value of the 'Startup Section' containment reference.

Parameters:
value - the new value of the 'Startup Section' containment reference.
See Also:
getStartupSection()

getStrings

StringsType getStrings()
Returns the value of the 'Strings' containment reference. Localized string resource bundles

Returns:
the value of the 'Strings' containment reference.
See Also:
setStrings(StringsType), EnvelopePackage.getDocumentRoot_Strings()

setStrings

void setStrings(StringsType value)
Sets the value of the 'Strings' containment reference.

Parameters:
value - the new value of the 'Strings' containment reference.
See Also:
getStrings()

getVirtualHardwareSection

VirtualHardwareSectionType getVirtualHardwareSection()
Returns the value of the 'Virtual Hardware Section' containment reference. Element substitutable for Section since VirtualHardwareSection_Type is a derivation of Section_Type

Returns:
the value of the 'Virtual Hardware Section' containment reference.
See Also:
setVirtualHardwareSection(VirtualHardwareSectionType), EnvelopePackage.getDocumentRoot_VirtualHardwareSection()

setVirtualHardwareSection

void setVirtualHardwareSection(VirtualHardwareSectionType value)
Sets the value of the 'Virtual Hardware Section' containment reference.

Parameters:
value - the new value of the 'Virtual Hardware Section' containment reference.
See Also:
getVirtualHardwareSection()

getVirtualSystem

VirtualSystemType getVirtualSystem()
Returns the value of the 'Virtual System' containment reference. Element substitutable for Content since VirtualSystem is a derivation of Content_Type

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

setVirtualSystem

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

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

getVirtualSystemCollection

VirtualSystemCollectionType getVirtualSystemCollection()
Returns the value of the 'Virtual System Collection' containment reference. Element substitutable for Content since VirtualSystem is a derivation of Content_Type

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

setVirtualSystemCollection

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

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

isRequired

boolean isRequired()
Returns the value of the 'Required' attribute. The default value is "true". Determines whether import should fail if the Section is not understood

Returns:
the value of the 'Required' attribute.
See Also:
isSetRequired(), unsetRequired(), setRequired(boolean), EnvelopePackage.getDocumentRoot_Required()

setRequired

void setRequired(boolean value)
Sets the value of the 'Required' attribute.

Parameters:
value - the new value of the 'Required' attribute.
See Also:
isSetRequired(), unsetRequired(), isRequired()

unsetRequired

void unsetRequired()
Unsets the value of the 'Required' attribute.

See Also:
isSetRequired(), isRequired(), setRequired(boolean)

isSetRequired

boolean isSetRequired()
Returns whether the value of the 'Required' attribute is set.

Returns:
whether the value of the 'Required' attribute is set.
See Also:
unsetRequired(), isRequired(), setRequired(boolean)


© Copyright 2008 IBM Corp. 2008 All Rights Reserved