org.osid.repository

Interface AssetContent

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, Subjugateable

public interface AssetContent
extends OsidObject, Subjugateable

AssetContent represents a version of content represented by an Asset. Although AssetContent is a separate OsidObject with its own Id to distuinguish it from other content inside an Asset, AssetContent can only be accessed through an Asset.

Once an Asset is selected, multiple contents should be negotiated using the size, fidelity, accessibility requirements or application evnironment.

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getAccessibilityTypes() Gets the accessibility types associated with this content.
Asset	getAsset() Gets the Asset corresponding to this content.
AssetContentRecord	getAssetContentRecord(Type assetContentContentRecordType) Gets the asset content record corresponding to the given AssetContent record Type.
Id	getAssetId() Gets the Asset Id corresponding to this content.
DataInputStream	getData() Gets the asset content data.
long	getDataLength() Gets the length of the data represented by this content in bytes.
java.lang.String	getURL() Gets the URL associated with this content for web-based retrieval.
boolean	hasDataLength() Tests if a data length is available.
boolean	hasURL() Tests if a URL is associated with this content.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getAssetId

Id getAssetId()

Gets the Asset Id corresponding to this content.

Returns:

the asset Id

Compliance:

mandatory - This method must be implemented.

getAsset

Asset getAsset()

Gets the Asset corresponding to this content.

Returns:

the asset

Compliance:

mandatory - This method must be implemented.

getAccessibilityTypes

TypeList getAccessibilityTypes()

Gets the accessibility types associated with this content.

Returns:

list of content accessibility types

Compliance:

mandatory - This method must be implemented.

hasDataLength

boolean hasDataLength()

Tests if a data length is available.

Returns:

true if a length is available for this content, false otherwise.

Compliance:

mandatory - This method must be implemented.

getDataLength

long getDataLength()

Gets the length of the data represented by this content in bytes.

Returns:

the length of the data stream

Throws:

IllegalStateException - hasDataLength() is false

Compliance:

mandatory - This method must be implemented.

getData

DataInputStream getData()
                        throws OperationFailedException

Gets the asset content data.

Returns:

the length of the content data

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

hasURL

boolean hasURL()

Tests if a URL is associated with this content.

Returns:

true if a URL is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getURL

java.lang.String getURL()

Gets the URL associated with this content for web-based retrieval.

Returns:

the url for this data

Throws:

IllegalStateException - hasURL() is false

Compliance:

mandatory - This method must be implemented.

getAssetContentRecord

AssetContentRecord getAssetContentRecord(Type assetContentContentRecordType)
                                         throws OperationFailedException

Gets the asset content record corresponding to the given AssetContent record Type. This method is used to retrieve an object implementing the requested record. The assetRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(assetRecordType) is true .

Parameters:

assetContentContentRecordType - the type of the record to retrieve

Returns:

the asset content record

Throws:

NullArgumentException - assetContentRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(assetContentRecordType) is false

Compliance:

mandatory - This method must be implemented.