org.osid.course.program

Interface CredentialLookupSession

All Superinterfaces:

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

public interface CredentialLookupSession
extends OsidSession

This session defines methods for retrieving credentials. A Credential is an award granted at he completion of a program.

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 course catalog view: All credential methods in this session operate, retrieve and pertain to credential defined explicitly in the current course catalog. Using an isolated view is useful for managing Credentials with the CredentialAdminSession.
• federated course catalog view: All credentials lookup methods in this session operate, retrieve and pertain to all credentials defined in this course catalog and any other credentials implicitly available in this course catalog through course catalog inheritence.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupCredentials() Tests if this user can perform Credential lookups.
CourseCatalog	getCourseCatalog() Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId() Gets the CourseCatalog Id associated with this session.
Credential	getCredential(Id credentialId) Gets the Credential specified by its Id.
CredentialList	getCredentials() Gets all Credentials.
CredentialList	getCredentialsByGenusType(Type credentialGenusType) Gets a CredentialList corresponding to the given credential genus Type which does not include credentials of types derived from the specified Type.
CredentialList	getCredentialsByIds(IdList credentialIds) Gets a CredentialList corresponding to the given IdList.
CredentialList	getCredentialsByParentGenusType(Type credentialGenusType) Gets a CredentialList corresponding to the given credential genus Type and include any additional credentials with genus types derived from the specified Type.
CredentialList	getCredentialsByRecordType(Type credentialRecordType) Gets a CredentialList containing the given credential record Type.
void	useComparativeCredentialView() 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	useFederatedCourseCatalogView() Federates the view for methods in this session.
void	useIsolatedCourseCatalogView() Isolates the view for methods in this session.
void	usePlenaryCredentialView() A complete view of the credential 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

getCourseCatalogId

Id getCourseCatalogId()

Gets the CourseCatalog Id associated with this session.

Returns:

the CourseCatalog Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCourseCatalog

CourseCatalog getCourseCatalog()
                               throws OperationFailedException,
                                      PermissionDeniedException

Gets the CourseCatalog associated with this session.

Returns:

the course catalog

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupCredentials

boolean canLookupCredentials()

Tests if this user can perform Credential 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 not offer lookup operations to unauthorized users.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeCredentialView

void useComparativeCredentialView()

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.

usePlenaryCredentialView

void usePlenaryCredentialView()

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

useFederatedCourseCatalogView

void useFederatedCourseCatalogView()

Federates the view for methods in this session. A federated view will include credentials in catalogs which are children of this catalog in the course catalog hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedCourseCatalogView

void useIsolatedCourseCatalogView()

Isolates the view for methods in this session. An isolated view restricts retrievals to this course catalog only.

Compliance:

mandatory - This method is must be implemented.

getCredential

Credential getCredential(Id credentialId)
                         throws NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

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

Parameters:

credentialId - the Id of the Credential to retrieve

Returns:

the returned Credential

Throws:

NotFoundException - no Credential found with the given Id

NullArgumentException - credentialId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCredentialsByIds

CredentialList getCredentialsByIds(IdList credentialIds)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

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

Parameters:

credentialIds - the list of Ids to retrieve

Returns:

the returned CredentialList list

Throws:

NotFoundException - an Id was not found

NullArgumentException - credentialIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCredentialsByGenusType

CredentialList getCredentialsByGenusType(Type credentialGenusType)
                                         throws OperationFailedException,
                                                PermissionDeniedException

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

Parameters:

credentialGenusType - a credential genus type

Returns:

the returned CredentialList list

Throws:

NullArgumentException - credentialGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCredentialsByParentGenusType

CredentialList getCredentialsByParentGenusType(Type credentialGenusType)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

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

Parameters:

credentialGenusType - a credential genus type

Returns:

the returned CredentialList list

Throws:

NullArgumentException - credentialGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCredentialsByRecordType

CredentialList getCredentialsByRecordType(Type credentialRecordType)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

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

Parameters:

credentialRecordType - a credential record type

Returns:

the returned CredentialList list

Throws:

NullArgumentException - credentialRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCredentials

CredentialList getCredentials()
                              throws OperationFailedException,
                                     PermissionDeniedException

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

Returns:

a list of Credentials

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.