org.dmtf.schemas.ovf.envelope
Interface ProductSectionType

All Superinterfaces:
EObject, Notifier, SectionType

public interface ProductSectionType
extends SectionType

A representation of the model object 'Product Section Type'. Product information for a virtual appliance

The following features are supported:

See Also:
EnvelopePackage.getProductSectionType()

Method Summary
 void addCategory(MsgType category)
          Add a category to the end of the product section
 void addProperty(PropertyType property)
          Add a property to the end of the product section
 void addProperty(PropertyType property, MsgType category)
          Add a property to the given category in a product section.
 FeatureMap getAny()
          Returns the value of the 'Any' attribute list.
 CimString getAppUrl()
          Returns the value of the 'App Url' containment reference.
 EList<MsgType> getCategory()
          Returns the value of the 'Category' containment reference list.
 java.lang.String getClass_()
          Returns the value of the 'Class' attribute.
 CimString getFullVersion()
          Returns the value of the 'Full Version' containment reference.
 FeatureMap getGroup()
          Returns the value of the 'Group' attribute list.
 EList<IconType> getIcon()
          Returns the value of the 'Icon' containment reference list.
 java.lang.String getInstance()
          Returns the value of the 'Instance' attribute.
 MsgType getProduct()
          Returns the value of the 'Product' containment reference.
 CimString getProductUrl()
          Returns the value of the 'Product Url' containment reference.
 EList<PropertyType> getProperty()
          Returns the value of the 'Property' containment reference list.
 EList<PropertyType> getProperty(MsgType category)
          Return all the properties in a given category
 PropertyType getPropertyForKey(java.lang.String key)
          Return a property with a given key
 MsgType getVendor()
          Returns the value of the 'Vendor' containment reference.
 CimString getVendorUrl()
          Returns the value of the 'Vendor Url' containment reference.
 CimString getVersion()
          Returns the value of the 'Version' containment reference.
 boolean isSetClass()
          Returns whether the value of the 'Class' attribute is set.
 boolean isSetInstance()
          Returns whether the value of the 'Instance' attribute is set.
 void setAppUrl(CimString value)
          Sets the value of the 'App Url' containment reference.
 void setClass(java.lang.String value)
          Sets the value of the 'Class' attribute.
 void setFullVersion(CimString value)
          Sets the value of the 'Full Version' containment reference.
 void setInstance(java.lang.String value)
          Sets the value of the 'Instance' attribute.
 void setProduct(MsgType value)
          Sets the value of the 'Product' containment reference.
 void setProductUrl(CimString value)
          Sets the value of the 'Product Url' containment reference.
 void setVendor(MsgType value)
          Sets the value of the 'Vendor' containment reference.
 void setVendorUrl(CimString value)
          Sets the value of the 'Vendor Url' containment reference.
 void setVersion(CimString value)
          Sets the value of the 'Version' containment reference.
 void unsetClass()
          Unsets the value of the 'Class' attribute.
 void unsetInstance()
          Unsets the value of the 'Instance' attribute.
 
Methods inherited from interface org.dmtf.schemas.ovf.envelope.SectionType
getAnyAttribute, getContent, getInfo, isRequired, isSetRequired, setContent, setInfo, setRequired, unsetRequired
 
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

getProduct

MsgType getProduct()
Returns the value of the 'Product' containment reference.

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

Name of product

Returns:
the value of the 'Product' containment reference.
See Also:
setProduct(MsgType), EnvelopePackage.getProductSectionType_Product()

setProduct

void setProduct(MsgType value)
Sets the value of the 'Product' containment reference.

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

getVendor

MsgType getVendor()
Returns the value of the 'Vendor' containment reference.

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

Name of product vendor

Returns:
the value of the 'Vendor' containment reference.
See Also:
setVendor(MsgType), EnvelopePackage.getProductSectionType_Vendor()

setVendor

void setVendor(MsgType value)
Sets the value of the 'Vendor' containment reference.

Parameters:
value - the new value of the 'Vendor' containment reference.
See Also:
getVendor()

getVersion

CimString getVersion()
Returns the value of the 'Version' containment reference.

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

Product version, short form

Returns:
the value of the 'Version' containment reference.
See Also:
setVersion(CimString), EnvelopePackage.getProductSectionType_Version()

setVersion

void setVersion(CimString value)
Sets the value of the 'Version' containment reference.

Parameters:
value - the new value of the 'Version' containment reference.
See Also:
getVersion()

getFullVersion

CimString getFullVersion()
Returns the value of the 'Full Version' containment reference.

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

Product version, long form

Returns:
the value of the 'Full Version' containment reference.
See Also:
setFullVersion(CimString), EnvelopePackage.getProductSectionType_FullVersion()

setFullVersion

void setFullVersion(CimString value)
Sets the value of the 'Full Version' containment reference.

Parameters:
value - the new value of the 'Full Version' containment reference.
See Also:
getFullVersion()

getProductUrl

CimString getProductUrl()
Returns the value of the 'Product Url' containment reference.

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

URL resolving to product description

Returns:
the value of the 'Product Url' containment reference.
See Also:
setProductUrl(CimString), EnvelopePackage.getProductSectionType_ProductUrl()

setProductUrl

void setProductUrl(CimString value)
Sets the value of the 'Product Url' containment reference.

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

getVendorUrl

CimString getVendorUrl()
Returns the value of the 'Vendor Url' containment reference.

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

URL resolving to vendor description

Returns:
the value of the 'Vendor Url' containment reference.
See Also:
setVendorUrl(CimString), EnvelopePackage.getProductSectionType_VendorUrl()

setVendorUrl

void setVendorUrl(CimString value)
Sets the value of the 'Vendor Url' containment reference.

Parameters:
value - the new value of the 'Vendor Url' containment reference.
See Also:
getVendorUrl()

getAppUrl

CimString getAppUrl()
Returns the value of the 'App Url' containment reference.

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

Experimental: URL resolving to deployed product instance

Returns:
the value of the 'App Url' containment reference.
See Also:
setAppUrl(CimString), EnvelopePackage.getProductSectionType_AppUrl()

setAppUrl

void setAppUrl(CimString value)
Sets the value of the 'App Url' containment reference.

Parameters:
value - the new value of the 'App Url' containment reference.
See Also:
getAppUrl()

getIcon

EList<IconType> getIcon()
Returns the value of the 'Icon' containment reference list. The list contents are of type IconType. It is bidirectional and its opposite is 'Product Section'.

If the meaning of the 'Icon' containment reference list isn't clear, there really should be more of a description here...

Experimental: Display icon for product

Returns:
the value of the 'Icon' containment reference list.
See Also:
EnvelopePackage.getProductSectionType_Icon(), IconType.getProductSection()

getGroup

FeatureMap getGroup()
Returns the value of the 'Group' attribute list. The list contents are of type FeatureMap.Entry. Properties for application-level customization

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

getCategory

EList<MsgType> getCategory()
Returns the value of the 'Category' containment reference list. The list contents are of type MsgType. Property grouping delimiter

Returns:
the value of the 'Category' containment reference list.
See Also:
EnvelopePackage.getProductSectionType_Category()

getProperty

EList<PropertyType> getProperty()
Returns the value of the 'Property' containment reference list. The list contents are of type PropertyType. It is bidirectional and its opposite is 'Product Section'. Property element

Returns:
the value of the 'Property' containment reference list.
See Also:
EnvelopePackage.getProductSectionType_Property(), PropertyType.getProductSection()

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

getClass_

java.lang.String getClass_()
Returns the value of the 'Class' attribute. The default value is "". Property identifier prefix

Returns:
the value of the 'Class' attribute.
See Also:
isSetClass(), unsetClass(), setClass(String), EnvelopePackage.getProductSectionType_Class()

setClass

void setClass(java.lang.String value)
Sets the value of the 'Class' attribute.

Parameters:
value - the new value of the 'Class' attribute.
See Also:
isSetClass(), unsetClass(), getClass_()

unsetClass

void unsetClass()
Unsets the value of the 'Class' attribute.

See Also:
isSetClass(), getClass_(), setClass(String)

isSetClass

boolean isSetClass()
Returns whether the value of the 'Class' attribute is set.

Returns:
whether the value of the 'Class' attribute is set.
See Also:
unsetClass(), getClass_(), setClass(String)

getInstance

java.lang.String getInstance()
Returns the value of the 'Instance' attribute. The default value is "". Property identifier suffix

Returns:
the value of the 'Instance' attribute.
See Also:
isSetInstance(), unsetInstance(), setInstance(String), EnvelopePackage.getProductSectionType_Instance()

setInstance

void setInstance(java.lang.String value)
Sets the value of the 'Instance' attribute.

Parameters:
value - the new value of the 'Instance' attribute.
See Also:
isSetInstance(), unsetInstance(), getInstance()

unsetInstance

void unsetInstance()
Unsets the value of the 'Instance' attribute.

See Also:
isSetInstance(), getInstance(), setInstance(String)

isSetInstance

boolean isSetInstance()
Returns whether the value of the 'Instance' attribute is set.

Returns:
whether the value of the 'Instance' attribute is set.
See Also:
unsetInstance(), getInstance(), setInstance(String)

addCategory

void addCategory(MsgType category)
Add a category to the end of the product section

Parameters:
category - Category to add

addProperty

void addProperty(PropertyType property)
Add a property to the end of the product section

Parameters:
property - Property to add

addProperty

void addProperty(PropertyType property,
                 MsgType category)
Add a property to the given category in a product section. If the category does not exist in the product section, add it first, then add the product to it.

Parameters:
property - Property to add
category - Category to receive the property, added if needed

getProperty

EList<PropertyType> getProperty(MsgType category)
Return all the properties in a given category

Parameters:
category -
Returns:
list of PropertyType instances in the category

getPropertyForKey

PropertyType getPropertyForKey(java.lang.String key)
Return a property with a given key

Parameters:
key -
Returns:
PropertyType instance with the given key value


© Copyright 2008 IBM Corp. 2008 All Rights Reserved