com.ibm.portal.resolver.data
Interface ContentDispositionDataSource

All Superinterfaces:
Addressable, DataSource, DataSourceFragment, Disposable, TimeStamped
All Known Implementing Classes:
AbstractDataSource

public interface ContentDispositionDataSource
extends DataSource

Captures information about the presentation of the data source

Since:
6.1.0
Note:
This interface is designed to be implemented by clients.

Nested Class Summary
static class ContentDispositionDataSource.DISPOSITION
          Possible content dispositions,
 
Field Summary
static long FILE_SIZE_UNKNOWN
          indicator for an unknown file size
 
Fields inherited from interface com.ibm.portal.resolver.data.DataSource
CONTENT_TYPE_UNKNOWN, CREATION_UNKNOWN, EXPIRATION_UNKNOWN, LAST_MODIFICATION_UNKNOWN, MAX_AGE_INFINITE, MAX_AGE_NONE, ROOT_DATE
 
Fields inherited from interface com.ibm.portal.resolver.data.Addressable
EMPTY_PARAMETERS
 
Method Summary
 ContentDispositionDataSource.DISPOSITION getDisposition()
          Returns the content disposition
 java.lang.String getFileName()
          Returns the desired filename
 long getFileSize()
          Returns the approximate file size of the data.
 
Methods inherited from interface com.ibm.portal.resolver.data.DataSource
getContentType, getCreated, getExpiration, getLastModified
 
Methods inherited from interface com.ibm.portal.resolver.data.Addressable
getParameters, getURI
 
Methods inherited from interface com.ibm.portal.Disposable
dispose
 

Field Detail

FILE_SIZE_UNKNOWN

static final long FILE_SIZE_UNKNOWN
indicator for an unknown file size

See Also:
Constant Field Values
Method Detail

getDisposition

ContentDispositionDataSource.DISPOSITION getDisposition()
Returns the content disposition

Returns:
the disposition, not null

getFileName

java.lang.String getFileName()
Returns the desired filename

Returns:
the filename or null

getFileSize

long getFileSize()
Returns the approximate file size of the data. Note that this is different from the information returned by ContentLengthDataSource.getContentLength().

Returns:
the file size, 0 or < 0. A value of < 0 indicates that the filesize is unknown.