Docs For Class Asset

Class Asset

Description

Asset manages the Asset itself. Assets have content as well as Records appropriate to the AssetType and RecordStructures for the Asset. Assets may also contain other Assets.

OSID Version: 2.0

Licensed under the org.osid.SidImplementationLicenseMIT.

Located in /harmoni/oki2/osid/repository/Asset.php (line 19)

Direct descendents

Class	Description
HarmoniAssetInterface	The HarmoniAssetInterface provides all of the methods of

Method Summary

void addAsset (mixed $assetId, object Id $assetId )

void copyRecordStructure (object Id $assetId, mixed $recordStructureId, object Id $recordStructureId )

object Record createRecord (mixed $recordStructureId, object Id $recordStructureId )

void deleteRecord (mixed $recordId, object Id $recordId )

object AssetIterator getAssets ()

object AssetIterator getAssetsByType (mixed $assetType, object Type $assetType )

object Type getAssetType ()

object mixed getContent ()

object RecordStructure getContentRecordStructure ()

string getDescription ()

string getDisplayName ()

int getEffectiveDate ()

int getExpirationDate ()

object Id getId ()

object Part getPart (mixed $partId, object Id $partId )

object PartIterator getPartsByPartStructure (mixed $partStructureId, object Id $partStructureId )

object mixed getPartValue (mixed $partId, object Id $partId )

object ObjectIterator getPartValuesByPartStructure (mixed $partStructureId, object Id $partStructureId )

object Record getRecord (mixed $recordId, object Id $recordId )

object RecordIterator getRecords ()

object RecordIterator getRecordsByRecordStructure (mixed $recordStructureId, object Id $recordStructureId )

object RecordIterator getRecordsByRecordStructureType (mixed $recordStructureType, object Type $recordStructureType )

object RecordStructureIterator getRecordStructures ()

object Id getRepository ()

void inheritRecordStructure (object Id $assetId, mixed $recordStructureId, object Id $recordStructureId )

void removeAsset (object Id $assetId, mixed $includeChildren, boolean $includeChildren )

void updateContent (object mixed $content)

void updateDescription (mixed $description, string $description )

void updateDisplayName (mixed $displayName, string $displayName )

void updateEffectiveDate (mixed $effectiveDate, int $effectiveDate )

void updateExpirationDate (mixed $expirationDate, int $expirationDate )

Methods

addAsset (line 359)

Add an Asset to this Asset.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID, ALREADY_ADDED

void addAsset (mixed $assetId, object Id $assetId )

object Id $assetId

Redefined in descendants as:

HarmoniAsset::addAsset() : Add an Asset to this Asset.

copyRecordStructure (line 533)

Add the specified RecordStructure and all the related Records from the specified asset.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID, CANNOT_COPY_OR_INHERIT_SELF

void copyRecordStructure (object Id $assetId, mixed $recordStructureId, object Id $recordStructureId )

object Id $assetId
object Id $recordStructureId

Redefined in descendants as:

HarmoniAsset::copyRecordStructure() : Add the specified RecordStructure and all the related Records from the specified asset.

createRecord (line 470)

Create a new Asset Record of the specified RecordStructure. The implementation of this method sets the Id for the new object.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID

object Record createRecord (mixed $recordStructureId, object Id $recordStructureId )

object Id $recordStructureId

Redefined in descendants as:

HarmoniAsset::createRecord() : Create a new Asset Record of the specified RecordStructure. The implementation of this method sets the Id for the new object.

deleteRecord (line 561)

Delete a Record. If the specified Record has content that is inherited by other Records, those other Records will not be deleted, but they will no longer have a source from which to inherit value changes.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID

void deleteRecord (mixed $recordId, object Id $recordId )

object Id $recordId

Redefined in descendants as:

HarmoniAsset::deleteRecord() : Delete a Record. If the specified Record has content that is inherited by other Records, those other Records will not be deleted, but they will no longer have a source from which to inherit value changes.

getAssets (line 411)

Get all the Assets in this Asset. Iterators return a set, one at a time.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object AssetIterator getAssets ()

Redefined in descendants as:

HarmoniAsset::getAssets() : Get all the Assets in this Asset. Iterators return a set, one at a time.

getAssetsByType (line 441)

Get all the Assets of the specified AssetType in this Repository.

Iterators return a set, one at a time.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_TYPE

object AssetIterator getAssetsByType (mixed $assetType, object Type $assetType )

object Type $assetType

Redefined in descendants as:

HarmoniAsset::getAssetsByType() : Get all the Assets of the specified AssetType in this Repository.

getAssetType (line 187)

Get the AssetType of this Asset. AssetTypes are used to categorize Assets.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object Type getAssetType ()

Redefined in descendants as:

HarmoniAsset::getAssetType() : Get the AssetType of this Asset. AssetTypes are used to categorize Assets.

getContent (line 306)

Get an Asset's content. This method can be a convenience if one is not interested in all the structure of the Records.

return: (original type: java.io.Serializable)
access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object mixed getContent ()

Redefined in descendants as:

HarmoniAsset::getContent() : Get an Asset's content. This method can be a convenience if one is not interested in all the structure of the Records.

getContentRecordStructure (line 691)

Get the RecordStructure associated with this Asset's content.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object RecordStructure getContentRecordStructure ()

Redefined in descendants as:

HarmoniAsset::getContentRecordStructure() : Get the RecordStructure associated with this Asset's content.

getDescription (line 140)

Get the description for this Asset.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

string getDescription ()

Redefined in descendants as:

HarmoniAsset::getDescription() : Get the description for this Asset.

getDisplayName (line 117)

Get the display name for this Asset.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

string getDisplayName ()

Redefined in descendants as:

HarmoniAsset::getDisplayName() : Get the display name for this Asset.

getEffectiveDate (line 210)

Get the date at which this Asset is effective.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

int getEffectiveDate ()

Redefined in descendants as:

HarmoniAsset::getEffectiveDate() : Get the date at which this Asset is effective.

getExpirationDate (line 233)

Get the date at which this Asset expires.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

int getExpirationDate ()

Redefined in descendants as:

HarmoniAsset::getExpirationDate() : Get the date at which this Asset expires.

getId (line 163)

Get the unique Id for this Asset.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object Id getId ()

Redefined in descendants as:

HarmoniAsset::getId() : Get the unique Id for this Asset.

getPart (line 748)

Get the Part for a Record for this Asset that matches this Part's unique Id.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID

object Part getPart (mixed $partId, object Id $partId )

object Id $partId

Redefined in descendants as:

HarmoniAsset::getPart() : Get the Part for a Record for this Asset that matches this Part's unique Id.

getPartsByPartStructure (line 806)

Get the Parts of the Records for this Asset that are based on this RecordStructure PartStructure's unique Id.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID

object PartIterator getPartsByPartStructure (mixed $partStructureId, object Id $partStructureId )

object Id $partStructureId

Redefined in descendants as:

HarmoniAsset::getPartsByPartStructure() : Get the Parts of the Records for this Asset that are based on this RecordStructure PartStructure's unique Id.

getPartValue (line 777)

Get the Value of the Part of the Record for this Asset that matches this Part's unique Id.

return: (original type: java.io.Serializable)
access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID

object mixed getPartValue (mixed $partId, object Id $partId )

object Id $partId

Redefined in descendants as:

HarmoniAsset::getPartValue() : Get the Value of the Part of the Record for this Asset that matches this Part's unique Id.

getPartValuesByPartStructure (line 835)

Get the Values of the Parts of the Records for this Asset that are based on this RecordStructure PartStructure's unique Id.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID

object ObjectIterator getPartValuesByPartStructure (mixed $partStructureId, object Id $partStructureId )

object Id $partStructureId

Redefined in descendants as:

HarmoniAsset::getPartValuesByPartStructure() : Get the Values of the Parts of the Records for this Asset that are based on this RecordStructure PartStructure's unique Id.

getRecord (line 719)

Get the Record for this Asset that matches this Record's unique Id.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID

object Record getRecord (mixed $recordId, object Id $recordId )

object Id $recordId

Redefined in descendants as:

HarmoniAsset::getRecord() : Get the Record for this Asset that matches this Record's unique Id.

getRecords (line 585)

Get all the Records for this Asset. Iterators return a set, one at a time.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object RecordIterator getRecords ()

Redefined in descendants as:

HarmoniAsset::getRecords() : Get all the Records for this Asset. Iterators return a set, one at a time.

getRecordsByRecordStructure (line 614)

Get all the Records of the specified RecordStructure for this Asset.

Iterators return a set, one at a time.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID

object RecordIterator getRecordsByRecordStructure (mixed $recordStructureId, object Id $recordStructureId )

object Id $recordStructureId

Redefined in descendants as:

HarmoniAsset::getRecordsByRecordStructure() : Get all the Records of the specified RecordStructure for this Asset.

getRecordsByRecordStructureType (line 643)

Get all the Records of the specified RecordStructureType for this Asset.

Iterators return a set, one at a time.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID

object RecordIterator getRecordsByRecordStructureType (mixed $recordStructureType, object Type $recordStructureType )

object Type $recordStructureType

Redefined in descendants as:

HarmoniAsset::getRecordsByRecordStructureType() : Get all the Records of the specified RecordStructureType for this Asset.

getRecordStructures (line 668)

Get all the RecordStructures for this Asset. RecordStructures are used to categorize information about Assets. Iterators return a set, one at a time.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object RecordStructureIterator getRecordStructures ()

Redefined in descendants as:

HarmoniAsset::getRecordStructures() : Get all the RecordStructures for this Asset. RecordStructures are used to categorize information about Assets. Iterators return a set, one at a time.

getRepository (line 282)

Get the Id of the Repository in which this Asset resides. This is set by the Repository's createAsset method.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object Id getRepository ()

Redefined in descendants as:

HarmoniAsset::getRepository() : Get the Id of the Repository in which this Asset resides. This is set by the Repository's createAsset method.

inheritRecordStructure (line 502)

Add the specified RecordStructure and all the related Records from the specified asset. The current and future content of the specified Record is synchronized automatically.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID, ALREADY_INHERITING_STRUCTURE

void inheritRecordStructure (object Id $assetId, mixed $recordStructureId, object Id $recordStructureId )

object Id $assetId
object Id $recordStructureId

Redefined in descendants as:

HarmoniAsset::inheritRecordStructure() : Add the specified RecordStructure and all the related Records from the specified asset. The current and future content of the specified Record is synchronized automatically.

removeAsset (line 387)

Remove an Asset from this Asset. This method does not delete the Asset from the Repository.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID

void removeAsset (object Id $assetId, mixed $includeChildren, boolean $includeChildren )

object Id $assetId
boolean $includeChildren

Redefined in descendants as:

HarmoniAsset::removeAsset() : Remove an Asset from this Asset. This method does not delete the Asset from the Repository.

updateContent (line 331)

Update an Asset's content.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT

void updateContent (object mixed $content)

object mixed $content: (original type: java.io.Serializable)

Redefined in descendants as:

HarmoniAsset::updateContent() : Update an Asset's content.

updateDescription (line 258)

Update the description for this Asset.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT

void updateDescription (mixed $description, string $description )

string $description

Redefined in descendants as:

HarmoniAsset::updateDescription() : Update the description for this Asset.

updateDisplayName (line 42)

Update the display name for this Asset.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT

void updateDisplayName (mixed $displayName, string $displayName )

string $displayName

Redefined in descendants as:

HarmoniAsset::updateDisplayName() : Update the display name for this Asset.

updateEffectiveDate (line 68)

Update the date at which this Asset is effective.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, EFFECTIVE_PRECEDE_EXPIRATION

void updateEffectiveDate (mixed $effectiveDate, int $effectiveDate )

int $effectiveDate

Redefined in descendants as:

HarmoniAsset::updateEffectiveDate() : Update the date at which this Asset is effective.

updateExpirationDate (line 94)

Update the date at which this Asset expires.

access: public
throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, EFFECTIVE_PRECEDE_EXPIRATION

void updateExpirationDate (mixed $expirationDate, int $expirationDate )

int $expirationDate

Redefined in descendants as:

HarmoniAsset::updateExpirationDate() : Update the date at which this Asset expires.

Documentation generated on Wed, 19 Sep 2007 10:21:33 -0400 by phpDocumentor 1.3.0RC3