org.osid.installation

Interface PackageSmartDepotSession

All Superinterfaces:

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

public interface PackageSmartDepotSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A PackageQuery can be retrieved from this session and mapped to this Depot to create a virtual collection of Packages. The packages may be sequenced using the PackageSearchOrder from this session.

This Depot has a default query that matches any package and a default search order that specifies no sequencing. The queries may be examined using a PackageQueryInspector. The query may be modified by converting the inspector back to a PackageQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyPackageQuery(PackageQuery packageQuery) Applies a package query to this depot.
void	applyPackageSequencing(PackageSearchOrder packageSearchOrder) Applies a package search order to this depot.
boolean	canManageSmartDepot() Tests if this user can manage smart depot.
Depot	getDepot() Gets the Depot associated with this session.
Id	getDepotId() Gets the Depot Id associated with this session.
PackageQuery	getPackageQuery() Gets a package query.
PackageQuery	getPackageQueryFromInspector(PackageQueryInspector packageQueryInspector) Gets a package query from an inspector.
PackageSearchOrder	getPackageSearchOrder() Gets a package search order.
PackageQueryInspector	inspectPackageQuery() Gets a package query inspector for this depot.

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

getDepotId

Id getDepotId()

Gets the Depot Id associated with this session.

Returns:

the Depot Id associated with this session

Compliance:

mandatory - This method must be implemented.

getDepot

Depot getDepot()
               throws OperationFailedException,
                      PermissionDeniedException

Gets the Depot associated with this session.

Returns:

the Depot associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartDepot

boolean canManageSmartDepot()

Tests if this user can manage smart depot. 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 depot management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getPackageQuery

PackageQuery getPackageQuery()

Gets a package query.

Returns:

the package query

Compliance:

mandatory - This method must be implemented.

getPackageSearchOrder

PackageSearchOrder getPackageSearchOrder()

Gets a package search order.

Returns:

the package search order

Compliance:

mandatory - This method must be implemented.

applyPackageQuery

void applyPackageQuery(PackageQuery packageQuery)
                       throws OperationFailedException,
                              PermissionDeniedException

Applies a package query to this depot.

Parameters:

packageQuery - the package query

Throws:

NullArgumentException - packageQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - packageQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectPackageQuery

PackageQueryInspector inspectPackageQuery()
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets a package query inspector for this depot.

Returns:

the package query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyPackageSequencing

void applyPackageSequencing(PackageSearchOrder packageSearchOrder)
                            throws OperationFailedException,
                                   PermissionDeniedException

Applies a package search order to this depot.

Parameters:

packageSearchOrder - the package search order

Throws:

NullArgumentException - packageSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - packageSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getPackageQueryFromInspector

PackageQuery getPackageQueryFromInspector(PackageQueryInspector packageQueryInspector)

Gets a package query from an inspector.

Parameters:

packageQueryInspector - a package query inspector

Returns:

the package query

Throws:

NullArgumentException - packageQueryInspector is null

UnsupportedException - packageQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.