org.osid.assessment

Interface AssessmentLookupSession

All Superinterfaces:

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

public interface AssessmentLookupSession
extends OsidSession

This session defines methods for retrieving assessments.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition
• isolated bank view: All assessment methods in this session operate, retrieve and pertain to assessments defined explicitly in the current bank. Using an isolated view is useful for managing Assessments with the AssessmentAdminSession.
• federated bank view: All assessment methods in this session operate, retrieve and pertain to all assessments defined in this bank and any other assessments implicitly available in this bank through bank inheritence.

The methods useFederatedBankView() and useIsolatedBankView() behave as a radio group and one should be selected before invoking any lookup methods.

Assessments may have a record indicated by their respective types. The record is accessed via the Assessment. The returns may not be cast directly from the returns in the lookup methods.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupAssessments() Tests if this user can perform Assessment lookups.
Assessment	getAssessment(Id assessmentId) Gets the Assessment specified by its Id.
AssessmentList	getAssessments() Gets all Assessments.
AssessmentList	getAssessmentsByGenusType(Type assessmentGenusType) Gets an AssessmentList corresponding to the given assessment genus Type which does not include assessments of types derived from the specified Type.
AssessmentList	getAssessmentsByIds(IdList assessmentIds) Gets an AssessmentList corresponding to the given IdList.
AssessmentList	getAssessmentsByParentGenusType(Type assessmentGenusType) Gets an AssessmentList corresponding to the given assessment genus Type and include any additional assessments with genus types derived from the specified Type.
AssessmentList	getAssessmentsByRecordType(Type assessmentRecordType) Gets an AssessmentList corresponding to the given assessment record Type.
Bank	getBank() Gets the Bank associated with this session.
Id	getBankId() Gets the Bank Id associated with this session.
void	useComparativeAssessmentView() The returns from the lookup methods may omit or translate elements based on this session, such as assessment, and not result in an error.
void	useFederatedBankView() Federates the view for methods in this session.
void	useIsolatedBankView() Isolates the view for methods in this session.
void	usePlenaryAssessmentView() A complete view of the Assessment 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

getBankId

Id getBankId()

Gets the Bank Id associated with this session.

Returns:

the Bank Id associated with this session

Compliance:

mandatory - This method must be implemented.

getBank

Bank getBank()
             throws OperationFailedException,
                    PermissionDeniedException

Gets the Bank associated with this session.

Returns:

the Bank associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupAssessments

boolean canLookupAssessments()

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

useComparativeAssessmentView

void useComparativeAssessmentView()

The returns from the lookup methods may omit or translate elements based on this session, such as assessment, 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.

usePlenaryAssessmentView

void usePlenaryAssessmentView()

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

useFederatedBankView

void useFederatedBankView()

Federates the view for methods in this session. A federated view will include assessments in banks which are children of this bank in the bank hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedBankView

void useIsolatedBankView()

Isolates the view for methods in this session. An isolated view restricts lookups to this bank only.

Compliance:

mandatory - This method is must be implemented.

getAssessment

Assessment getAssessment(Id assessmentId)
                         throws NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

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

Parameters:

assessmentId - Id of the Assessment

Returns:

the assessment

Throws:

NotFoundException - assessmentId not found

NullArgumentException - assessmentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method is must be implemented.

getAssessmentsByIds

AssessmentList getAssessmentsByIds(IdList assessmentIds)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

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

Parameters:

assessmentIds - the list of Ids to retrieve

Returns:

the returned Assessment list

Throws:

NotFoundException - an Id was not found

NullArgumentException - assessmentIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - assessment failure

Compliance:

mandatory - This method must be implemented.

getAssessmentsByGenusType

AssessmentList getAssessmentsByGenusType(Type assessmentGenusType)
                                         throws OperationFailedException,
                                                PermissionDeniedException

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

Parameters:

assessmentGenusType - an assessment genus type

Returns:

the returned Assessment list

Throws:

NullArgumentException - assessmentGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getAssessmentsByParentGenusType

AssessmentList getAssessmentsByParentGenusType(Type assessmentGenusType)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

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

Parameters:

assessmentGenusType - an assessment genus type

Returns:

the returned Assessment list

Throws:

NullArgumentException - assessmentGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getAssessmentsByRecordType

AssessmentList getAssessmentsByRecordType(Type assessmentRecordType)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets an AssessmentList corresponding to the given assessment record Type. The set of assessments implementing the given record type is returned. In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments that are accessible through this session.

Parameters:

assessmentRecordType - an assessment record type

Returns:

the returned Assessment list

Throws:

NullArgumentException - assessmentRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getAssessments

AssessmentList getAssessments()
                              throws OperationFailedException,
                                     PermissionDeniedException

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

Returns:

a list of Assessments

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.