org.dmtf.schemas.ovf.envelope
Interface FileType

All Superinterfaces:
EObject, LocalHostResource, Notifier

public interface FileType
extends LocalHostResource

A representation of the model object 'File Type'. Type for an external reference to a resource

The following features are supported:

See Also:
EnvelopePackage.getFileType()

Method Summary
 FeatureMap getAny()
          Returns the value of the 'Any' attribute list.
 FeatureMap getAnyAttribute()
          Returns the value of the 'Any Attribute' attribute list.
 long getChunkSize()
          Returns the value of the 'Chunk Size' attribute.
 CompressionTypes getCompression()
          Returns the value of the 'Compression' attribute.
 java.lang.String getHref()
          Returns the value of the 'Href' attribute.
 java.lang.String getId()
          Returns the value of the 'Id' attribute.
 java.lang.String getLocalRef()
          Returns the value of the 'Local Ref' attribute.
 ReferencesType getReferences()
          Returns the value of the 'References' container reference.
 java.math.BigInteger getSize()
          Returns the value of the 'Size' attribute.
 boolean isPackaged()
          Returns the value of the 'Packaged' attribute.
 boolean isResourceBundle()
          Returns the value of the 'Resource Bundle' attribute.
 boolean isSetChunkSize()
          Returns whether the value of the 'Chunk Size' attribute is set.
 boolean isSetCompression()
          Returns whether the value of the 'Compression' attribute is set.
 void setChunkSize(long value)
          Sets the value of the 'Chunk Size' attribute.
 void setCompression(CompressionTypes value)
          Sets the value of the 'Compression' attribute.
 void setHref(java.lang.String value)
          Sets the value of the 'Href' attribute.
 void setId(java.lang.String value)
          Sets the value of the 'Id' attribute.
 void setLocalRef(java.lang.String value)
          Sets the value of the 'Local Ref' attribute.
 void setReferences(ReferencesType value)
          Sets the value of the 'References' container reference.
 void setSize(java.math.BigInteger value)
          Sets the value of the 'Size' attribute.
 void unsetChunkSize()
          Unsets the value of the 'Chunk Size' attribute.
 void unsetCompression()
          Unsets the value of the 'Compression' attribute.
 
Methods inherited from interface org.dmtf.schemas.wscim.rasd.LocalHostResource
getUri
 
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

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

getChunkSize

long getChunkSize()
Returns the value of the 'Chunk Size' attribute. Chunk size (except for last chunk)

Returns:
the value of the 'Chunk Size' attribute.
See Also:
isSetChunkSize(), unsetChunkSize(), setChunkSize(long), EnvelopePackage.getFileType_ChunkSize()

setChunkSize

void setChunkSize(long value)
Sets the value of the 'Chunk Size' attribute.

Parameters:
value - the new value of the 'Chunk Size' attribute.
See Also:
isSetChunkSize(), unsetChunkSize(), getChunkSize()

unsetChunkSize

void unsetChunkSize()
Unsets the value of the 'Chunk Size' attribute.

See Also:
isSetChunkSize(), getChunkSize(), setChunkSize(long)

isSetChunkSize

boolean isSetChunkSize()
Returns whether the value of the 'Chunk Size' attribute is set.

Returns:
whether the value of the 'Chunk Size' attribute is set.
See Also:
unsetChunkSize(), getChunkSize(), setChunkSize(long)

getCompression

CompressionTypes getCompression()
Returns the value of the 'Compression' attribute. The default value is "identity". The literals are from the enumeration CompressionTypes. Compression type (gzip, bzip2, or none if empty or not specified)

Returns:
the value of the 'Compression' attribute.
See Also:
CompressionTypes, isSetCompression(), unsetCompression(), setCompression(CompressionTypes), EnvelopePackage.getFileType_Compression()

setCompression

void setCompression(CompressionTypes value)
Sets the value of the 'Compression' attribute.

Parameters:
value - the new value of the 'Compression' attribute.
See Also:
CompressionTypes, isSetCompression(), unsetCompression(), getCompression()

unsetCompression

void unsetCompression()
Unsets the value of the 'Compression' attribute.

See Also:
isSetCompression(), getCompression(), setCompression(CompressionTypes)

isSetCompression

boolean isSetCompression()
Returns whether the value of the 'Compression' attribute is set.

Returns:
whether the value of the 'Compression' attribute is set.
See Also:
unsetCompression(), getCompression(), setCompression(CompressionTypes)

getHref

java.lang.String getHref()
Returns the value of the 'Href' attribute. Location of external resource

Returns:
the value of the 'Href' attribute.
See Also:
setHref(String), EnvelopePackage.getFileType_Href()

setHref

void setHref(java.lang.String value)
Sets the value of the 'Href' attribute.

Parameters:
value - the new value of the 'Href' attribute.
See Also:
getHref()

getId

java.lang.String getId()
Returns the value of the 'Id' attribute. Reference key used in other parts of the package

Returns:
the value of the 'Id' attribute.
See Also:
setId(String), EnvelopePackage.getFileType_Id()

setId

void setId(java.lang.String value)
Sets the value of the 'Id' attribute.

Parameters:
value - the new value of the 'Id' attribute.
See Also:
getId()

getLocalRef

java.lang.String getLocalRef()
Returns the value of the 'Local Ref' attribute.

The localRef is an IBM extension that is used to indicate an alternative location for a file

Returns:
the value of the 'Local Ref' attribute.
See Also:
setLocalRef(String), EnvelopePackage.getFileType_LocalRef()

setLocalRef

void setLocalRef(java.lang.String value)
Sets the value of the 'Local Ref' attribute. The localRef attribute is an IBM extension that records an absolute URI for a file on the local filesystem. It is used when the href attribute is insufficient to locate the file.

Parameters:
value - the new value of the 'Local Ref' attribute.
See Also:
getLocalRef()

isPackaged

boolean isPackaged()
Returns the value of the 'Packaged' attribute.

Indicates whether this file is to be packaged in an OVF package. A file is packaged if the href attribute is a relative path.

Returns:
the value of the 'Packaged' attribute.
See Also:
EnvelopePackage.getFileType_Packaged()

isResourceBundle

boolean isResourceBundle()
Returns the value of the 'Resource Bundle' attribute.

Indicates whether this file is an external resource bundle. It is inferred from references by StringsType instances in the descriptor.

Returns:
the value of the 'Resource Bundle' attribute.
See Also:
EnvelopePackage.getFileType_ResourceBundle()

getSize

java.math.BigInteger getSize()
Returns the value of the 'Size' attribute. Size in bytes of the files (if known)

Returns:
the value of the 'Size' attribute.
See Also:
setSize(BigInteger), EnvelopePackage.getFileType_Size()

setSize

void setSize(java.math.BigInteger value)
Sets the value of the 'Size' attribute.

Parameters:
value - the new value of the 'Size' attribute.
See Also:
getSize()

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

getReferences

ReferencesType getReferences()
Returns the value of the 'References' container reference. It is bidirectional and its opposite is 'File'.

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

Returns:
the value of the 'References' container reference.
See Also:
setReferences(ReferencesType), EnvelopePackage.getFileType_References(), ReferencesType.getFile()

setReferences

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

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


© Copyright 2008 IBM Corp. 2008 All Rights Reserved