Package org.osid.repository
The Open Service Interface Definitions for the org.osid.repository service.
The Repository OSID provides the service of finding and managing digital assets.
Assets
An Asset represents a unit of content, whether it be an image,
a video, an application document or some text. The Asset defines a core set
of definitions applicable to digital content, such as copyright and
publisher, and allows for a type specification to be appended as with other
OsidObjects .
Asset content, such as a document, is defined such that there may be multiple formats contained with the same asset. A document may be accessible in both PDF and MS Word, but is the same document, for example. An image may have both a large size and a thumbnail version. Generally, an asset contains more than one version of content when it is left to the application to decide which is most appropriate.
The Asset Type may define methods in common throughout
the content variations. An example asset is one whose content Types
are "Quicktime" and "MPEG", but the Asset Type is "movie"
and defines methods that describe the move aside from the formats. This
"double" Type hierarchy stemming from the asset requires more care in
defining interfaces.
Assets also have "credits" which define the authors, editors,
creators, performers, producers or any other "role", identified with a role
Type , with the production of the asset. These are managed
externally to the asset through another OsidSession .
Through additional optional OsidSessions , the Asset
can be "extended" to offer temporal information. An asset may pertain to a
date, a period of time, or a series of dates and periods. This mechanism is
to offer the ability to search for assets pertaining to a desired date
range without requiring understanding of a Type .
Similarly, the Asset can also map to spatial information. A
photograph may be "geotagged" with the GPS coordinates where it was taken,
a conical shape in stellar coordinates could be described for an
astronimocal image, or there may be a desire to may a historical book to
the spatial coordinates of Boston and Philadelphia. Unlike temporal
mappings, the definition of the spatial coordinate is left to a spatial
Type to define. The Repository OSID simply manages spatial mappings to the
Asset.
Asset Tagging
Assets may also relate to Ontology OSID Subjects . The
Subject provides the ability to normalize information related to
subject matter across the Assets to simplify management and provide
a more robust searching mechanism. For example, with a photograph of the
Empire State Building, one may wish to describe that it was designed by
Shreve, Lamb and Harmon and completed in 1931. The information about the
building itself can be described using a Subject and related to the
photograph, and any other photograph that captures the building. The
Asset Type for the photograph may simply be "photograph" and
doesn't attempt to describe a building, while the AssetContent
Type is "image/jpeg".
An application performing a search for Empire State Building can be
execute the search over the Subjects , and once the user has
narrowed the subject area, then the related Assets can be retrieved, and
from there negotiate the content.
A provider wishing to construct a simple inventory database of
buildings in New York may decide to do so using the Resource OSID. The
Resource Type may describe the construction dates, height,
location, style and architects of buildings. The Type may also
include a means of getting a reference image using the Asset
interface. Since there is no explicit relationship between Subject
and Resource , the Resource can be adapted to the
Subject interface (mapping a buildingResourceType to a
buildingSubjectType ) to use the same data for Subject to
Asset mappings and searching.
Asset Compositions
Asset compositions can be created using the Composition
interface. A Composition is a group of Assets and
compositions may be structured into a hierarchy for the purpose of
"building" larger content. A content management system may make use of this
interface to construct a web page. The Composition hierarchy may
map into an XHTML structure and each Asset represent an image or a
link in the document. However, the produced web page at a given URL may be
represented by another single Asset that whose content has both the
URL and the XHTML stream.
Another example is an IMS Common Cartridge. The Composition may
be used to produce the zip file cartridge, but consumers may access the zip
file via an Asset .
Repository Cataloging
Finally, Assets and Compositions may be categorized
into Repository objects. A Repository is a catalog-like
interface to help organize assets and subject matter. Repositories may be
organized into hierarchies for organization or federation purposes.
This number of service aspects to this Repository OSID produce a large
number of definitions. It is recommended to use the
RepositoryManager definition to select a single OsidSession of
interest, and work that definition through its dependencies before tackling
another aspect.
Sub Packages
The Repository OSID includes a rules subpackage for managing dynamic compositions.
Copyright © 2002-2004, 2007-2008 Massachusetts Institute of Technology.
Copyright © 2010-2011,2014 Ingenescus. All Rights Reserved.
This Work is being provided by the copyright holder(s) subject to the following license. By obtaining, using and/or copying this Work, you agree that you have read, understand, and will comply with the following terms and conditions.
Permission to use, copy and distribute unmodified versions of this Work, for any purpose, without fee or royalty is hereby granted, provided that you include the above copyright notices and the terms of this license on ALL copies of the Work or portions thereof.
You may nodify or create Derivatives of this Work only for your internal purposes. You shall not distribute or transfer any such Derivative of this Work to any location or to any third party. For the purposes of this license, "Derivative" shall mean any derivative of the Work as defined in the United States Copyright Act of 1976, such as a translation or modification.
This Work and the information contained herein is provided on an "AS IS" basis WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS IN THE WORK.
The export of software employing encryption technology may require a specific license from the United States Government. It is the responsibility of any person or organization contemplating export to obtain such a license before exporting this Work.
-
InterfacesClassDescriptionAn
Assetrepresents some digital content.This session creates, updates, and deletesAssets.This session provides the means for adding assets to an asset composition.This session defines methods for looking upAssettoCompositionmappings.AssetContentrepresents a version of content represented by anAsset.This session creates, updates, and deletesAssetContents.This is the form for creating and updating content forAssetContent.Like allOsidLists,AssetContentListprovides a means for accessingAssetContentelements sequentially either one at a time or many at a time.This session provides methods for retrievingAssetContents.This session defines methods to receive notifications on adds/changes toAssetContentsin thisRepository.This is the query for searching asset contents.This is the query inspector for examining asset content queries.This session provides methods for searching amongAssetContents.The asset content receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deletedAssetContentobjects.This session provides methods to re-assignAssetContentstoRepositorymappings.This session provides methods to retrieveAssetContenttoRepositorymappings.The search interface for governing asset content searches.An interface for specifying the ordering of search results.This interface provides a means to capture results of a search.This session provides methods for searching amongAssetContents.This session manages queries and sequencing to create "smart" dynamic catalogs.This is the form for creating and updatingAssets.Like allOsidLists,AssetListprovides a means for accessingAssetelements sequentially either one at a time or many at a time.This session defines methods for retrieving assets.This session defines methods to receive notifications on adds/changes toAssetobjects in thisRepository.This is the query for searching assets.This is the query inspector for examining asset queries.This session provides methods for searching amongAssetobjects.The asset receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deletedAssetobjects.This session provides methods to re-assignAssetstoRepositories.This session provides methods to retrieveAssetstoRepositorymappings.The search interface for governing asset searches.An interface for specifying the ordering of search results.This interface provides a means to capture results of a search.This session provides methods for searching amongAssetobjects.This session manages queries and sequencing to create "smart" dynamic catalogs.This session defines methods to manage the spatial coverage of an asset.This session defines methods to access spatial mappings of an asset.This session defines methods to manage temporal coverage of an asset.This session defines a means for accessing temporal coverage of an asset.ACompositionrepresents an authenticatable identity.This session creates, updates, and deletesCompositions.This is the form for creating and updatingCompositions.Like allOsidLists,CompositionListprovides a means for accessingCompositionelements sequentially either one at a time or many at a time.This session provides methods for retrievingCompositionobjects.This session defines methods to receive notifications on adds/changes toCompositionobjects in thisRepository.This is the query for searching compositions.This is the query inspector for examining composition queries.This session provides methods for searching amongCompositionobjects.The composition receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deletedCompositionobjects.This session provides methods to re-assignCompositionstoRepositoryobjects.This session provides methods to retrieveCompositiontoRepositorymappings.The interface for governing composition searches.An interface for specifying the ordering of search results.This interface provides a means to capture results of a search.This session provides methods for searching amongCompositionobjects.This session manages queries and sequencing to create "smart" dynamic catalogs.A repository defines a collection of assets.This session creates, updates, and deletesRepositories.This is the form for creating and updating repositories.This session defines methods for managing a hierarchy ofRepositoryobjects.This session defines methods for traversing a hierarchy ofRepositoryobjects.Like allOsidLists,RepositoryListprovides a means for accessingRepositoryelements sequentially either one at a time or many at a time.This session provides methods for retrievingRepositoryobjects.The repository manager provides access to asset lookup and creation session and provides interoperability tests for various aspects of this service.This interface is a container for a partial hierarchy retrieval.Like allOsidLists,RepositoryNodeListprovides a means for accessingRepositoryNodeelements sequentially either one at a time or many at a time.This session defines methods to receive notifications on adds/changes toRepositoryobjects.The repository profile describes interoperability among repository services.The repository manager provides access to asset lookup and creation session and provides interoperability tests for various aspects of this service.This is the query for searching repositories.This is the query inspector for examining repository queries.This session provides methods for searching amongRepositoryobjects.The repository receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deletedRepositoryobjects.The interface for governing repository searches.An interface for specifying the ordering of search results.This interface provides a means to capture results of a search.This session provides methods for searching amongRepositoryobjects.