org.osid.hold

Interface OublietteLookupSession

All Superinterfaces:

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

public interface OublietteLookupSession
extends OsidSession

This session provides methods for retrieving Oubliette objects. The Oubliette represents a collection of holds and issues.

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 Oubliette it can access, without breaking execution. However, an assessment may only be useful if all Oubliette referenced by it are available, and a test-taking application may sacrifice some interoperability for the sake of precision.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupOubliettes() Tests if this user can perform Oubliette lookups.
Oubliette	getOubliette(Id oublietteId) Gets the Oubliette specified by its Id.
OublietteList	getOubliettes() Gets all Oubliette In plenary mode, the returned list contains all known oubliettes or an error results.
OublietteList	getOubliettesByGenusType(Type oublietteGenusType) Gets a OublietteList corresponding to the given oubliette genus Type which does not include oubliettes of types derived from the specified Type.
OublietteList	getOubliettesByIds(IdList oublietteIds) Gets a OublietteList corresponding to the given IdList.
OublietteList	getOubliettesByParentGenusType(Type oublietteGenusType) Gets a OublietteList corresponding to the given oubliette genus Type and include any additional oubliettes with genus types derived from the specified Type.
OublietteList	getOubliettesByProvider(Id resourceId) Gets a OublietteList for the given provider .
OublietteList	getOubliettesByRecordType(Type oublietteRecordType) Gets a OublietteList containing the given oubliette record Type.
void	useComparativeOublietteView() 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	usePlenaryOublietteView() A complete view of the Oubliette 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

canLookupOubliettes

boolean canLookupOubliettes()

Tests if this user can perform Oubliette 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.

useComparativeOublietteView

void useComparativeOublietteView()

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.

usePlenaryOublietteView

void usePlenaryOublietteView()

A complete view of the Oubliette 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.

getOubliette

Oubliette getOubliette(Id oublietteId)
                       throws NotFoundException,
                              OperationFailedException,
                              PermissionDeniedException

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

Parameters:

oublietteId - Id of the Oubliette

Returns:

the oubliette

Throws:

NotFoundException - oublietteId not found

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getOubliettesByIds

OublietteList getOubliettesByIds(IdList oublietteIds)
                                 throws NotFoundException,
                                        OperationFailedException,
                                        PermissionDeniedException

Gets a OublietteList corresponding to the given IdList. In plenary mode, the returned list contains all of the oubliettes 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 Oubliettes may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

oublietteIds - the list of Ids to retrieve

Returns:

the returned Oubliette list

Throws:

NotFoundException - an Id was not found

NullArgumentException - oublietteIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOubliettesByGenusType

OublietteList getOubliettesByGenusType(Type oublietteGenusType)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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

Parameters:

oublietteGenusType - an oubliette genus type

Returns:

the returned Oubliette list

Throws:

NullArgumentException - oublietteGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOubliettesByParentGenusType

OublietteList getOubliettesByParentGenusType(Type oublietteGenusType)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

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

Parameters:

oublietteGenusType - an oubliette genus type

Returns:

the returned Oubliette list

Throws:

NullArgumentException - oublietteGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOubliettesByRecordType

OublietteList getOubliettesByRecordType(Type oublietteRecordType)
                                        throws OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

oublietteRecordType - an oubliette record type

Returns:

the returned Oubliette list

Throws:

NullArgumentException - oublietteRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOubliettesByProvider

OublietteList getOubliettesByProvider(Id resourceId)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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

Parameters:

resourceId - a resource Id

Returns:

the returned Oubliette list

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOubliettes

OublietteList getOubliettes()
                            throws OperationFailedException,
                                   PermissionDeniedException

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

Returns:

a list of Oubliettes

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.