org.osid.installation

Interface DepotLookupSession

All Superinterfaces:

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

public interface DepotLookupSession
extends OsidSession

This session provides methods for retrieving Depot objects. The Depot represents a collection of Packages.

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Depots it can access, without breaking execution. However, an administrative application may require all Depot elements to be available.

Depots may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Depot.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupDepots() Tests if this user can perform Depot lookups.
Depot	getDepot(Id depotId) Gets the Depot specified by its Id.
DepotList	getDepots() Gets all Depots.
DepotList	getDepotsByGenusType(Type depotGenusType) Gets a DepotList corresponding to the given depot genus Type which does not include depots of types derived from the specified Type.
DepotList	getDepotsByIds(IdList depotIds) Gets a DepotList corresponding to the given IdList.
DepotList	getDepotsByParentGenusType(Type depotGenusType) Gets a DepotList corresponding to the given depot genus Type and include any additional depots with genus types derived from the specified Type.
DepotList	getDepotsByProvider(Id resourceId) Gets a DepotList for the given provider .
DepotList	getDepotsByRecordType(Type depotRecordType) Gets a DepotList containing the given depot record Type.
void	useComparativeDepotView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryDepotView() A complete view of the Depot returns is desired.

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

canLookupDepots

boolean canLookupDepots()

Tests if this user can perform Depot lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup operations to unauthorized users.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeDepotView

void useComparativeDepotView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryDepotView

void usePlenaryDepotView()

A complete view of the Depot returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getDepot

Depot getDepot(Id depotId)
               throws NotFoundException,
                      OperationFailedException,
                      PermissionDeniedException

Gets the Depot specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Depot may have a different Id than requested, such as the case where a duplicate Id was assigned to a Depot and retained for compatility.

Parameters:

depotId - Id of the Depot

Returns:

the depot

Throws:

NotFoundException - depotId not found

NullArgumentException - depotId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getDepotsByIds

DepotList getDepotsByIds(IdList depotIds)
                         throws NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

Gets a DepotList corresponding to the given IdList. In plenary mode, the returned list contains all of the depots specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Depot objects may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

depotIds - the list of Ids to retrieve

Returns:

the returned Depot list

Throws:

NotFoundException - an Id was not found

NullArgumentException - depotIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDepotsByGenusType

DepotList getDepotsByGenusType(Type depotGenusType)
                               throws OperationFailedException,
                                      PermissionDeniedException

Gets a DepotList corresponding to the given depot genus Type which does not include depots of types derived from the specified Type. In plenary mode, the returned list contains all known depots or an error results. Otherwise, the returned list may contain only those depots that are accessible through this session.

Parameters:

depotGenusType - a depot genus type

Returns:

the returned Depot list

Throws:

NullArgumentException - depotGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDepotsByParentGenusType

DepotList getDepotsByParentGenusType(Type depotGenusType)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Gets a DepotList corresponding to the given depot genus Type and include any additional depots with genus types derived from the specified Type. In plenary mode, the returned list contains all known depots or an error results. Otherwise, the returned list may contain only those depots that are accessible through this session.

Parameters:

depotGenusType - a depot genus type

Returns:

the returned Depot list

Throws:

NullArgumentException - depotGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDepotsByRecordType

DepotList getDepotsByRecordType(Type depotRecordType)
                                throws OperationFailedException,
                                       PermissionDeniedException

Gets a DepotList containing the given depot record Type. In plenary mode, the returned list contains all known depots or an error results. Otherwise, the returned list may contain only those depots that are accessible through this session.

Parameters:

depotRecordType - a depot record type

Returns:

the returned Depot list

Throws:

NullArgumentException - depotRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDepotsByProvider

DepotList getDepotsByProvider(Id resourceId)
                              throws OperationFailedException,
                                     PermissionDeniedException

Gets a DepotList for the given provider . In plenary mode, the returned list contains all known depots or an error results. Otherwise, the returned list may contain only those depots that are accessible through this session.

Parameters:

resourceId - a resource Id

Returns:

the returned Depot list

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDepots

DepotList getDepots()
                    throws OperationFailedException,
                           PermissionDeniedException

Gets all Depots. In plenary mode, the returned list contains all known depots or an error results. Otherwise, the returned list may contain only those depots that are accessible through this session.

Returns:

a DepotList

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.