org.osid.repository

Interface AssetSmartRepositorySession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface AssetSmartRepositorySession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. An AssetQuery can be retrieved from this session and mapped to this Repository to create a virtual collection of Assets. The assets may be sequenced using the AssetSearchOrder from this session.

This Repository has a default query that matches any asset and a default search order that specifies no sequencing. The queries may be examined using an AssetQueryInspector. The query may be modified by converting the inspector back to an AssetQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyAssetQuery(AssetQuery assetQuery) Applies an asset query to this repository.
void	applyAssetSequencing(AssetSearchOrder assetSearchOrder) Applies an asset search order to this repository.
boolean	canManageSmartRepository() Tests if this user can manage smart repository.
AssetQuery	getAssetQuery() Gets na asset query.
AssetQuery	getAssetQueryFromInspector(AssetQueryInspector assetQueryInspector) Gets an asset query from an inspector.
AssetSearchOrder	getAssetSearchOrder() Gets an asset search order.
Repository	getRepository() Gets the Repository associated with this session.
Id	getRepositoryId() Gets the Repository Id associated with this session.
AssetQueryInspector	inspectAssetQuery() Gets an asset query inspector for this repository.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getRepositoryId

Id getRepositoryId()

Gets the Repository Id associated with this session.

Returns:

the Repository Id associated with this session

Compliance:

mandatory - This method must be implemented.

getRepository

Repository getRepository()
                         throws OperationFailedException,
                                PermissionDeniedException

Gets the Repository associated with this session.

Returns:

the Repository associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartRepository

boolean canManageSmartRepository()

Tests if this user can manage smart repository. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.

Returns:

false if smart repository management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getAssetQuery

AssetQuery getAssetQuery()

Gets na asset query.

Returns:

the asset query

Compliance:

mandatory - This method must be implemented.

getAssetSearchOrder

AssetSearchOrder getAssetSearchOrder()

Gets an asset search order.

Returns:

the asset search order

Compliance:

mandatory - This method must be implemented.

applyAssetQuery

void applyAssetQuery(AssetQuery assetQuery)
                     throws OperationFailedException,
                            PermissionDeniedException

Applies an asset query to this repository.

Parameters:

assetQuery - the asset query

Throws:

NullArgumentException - assetQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - assetQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectAssetQuery

AssetQueryInspector inspectAssetQuery()
                                      throws OperationFailedException,
                                             PermissionDeniedException

Gets an asset query inspector for this repository.

Returns:

the asset query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyAssetSequencing

void applyAssetSequencing(AssetSearchOrder assetSearchOrder)
                          throws OperationFailedException,
                                 PermissionDeniedException

Applies an asset search order to this repository.

Parameters:

assetSearchOrder - the asset search order

Throws:

NullArgumentException - assetSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - assetSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getAssetQueryFromInspector

AssetQuery getAssetQueryFromInspector(AssetQueryInspector assetQueryInspector)

Gets an asset query from an inspector.

Parameters:

assetQueryInspector - a resorce relationship query inspector

Returns:

the asset query

Throws:

NullArgumentException - assetQueryInspector is null

UnsupportedException - assetQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.