org.osid.learning

Interface ProficiencyObjectiveBankSession

All Superinterfaces:

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

public interface ProficiencyObjectiveBankSession
extends OsidSession

This session provides methods to retrieve Proficiency to ObjectiveBank mappings. A Proficiency may appear in multiple ObjectiveBank objects. Each objective bank may have its own authorizations governing who is allowed to look at it.

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupProficiencyObjectiveBankMappings() Tests if this user can perform lookups of proficiency/objective bank mappings.
IdList	getObjectiveBankIdsByProficiency(Id proficiencyId) Gets the ObjectiveBank Ids mapped to a Proficiency.
ObjectiveBankList	getObjectiveBanksByProficiency(Id proficiencyId) Gets the ObjectiveBanks mapped to a Proficiency.
ProficiencyList	getProficienciesByObjectiveBank(Id objectiveBankId) Gets the list of Proficiencies associated with a ObjectiveBank.
ProficiencyList	getProficienciesByObjectiveBanks(IdList objectiveBankIds) Gets the list of Proficiencies corresponding to a list of ObjectiveBanks.
IdList	getProficiencyIdsByObjectiveBank(Id objectiveBankId) Gets the list of Proficiency Ids associated with a ObjectiveBank.
IdList	getProficiencyIdsByObjectiveBanks(IdList objectiveBankIds) Gets the list of Proficiency Ids corresponding to a list of ObjectiveBanks.
void	useComparativeProficiencyObjectiveBankView() 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	usePlenaryProficiencyObjectiveBankView() A complete view of the Proficiency and ObjectiveBank 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

canLookupProficiencyObjectiveBankMappings

boolean canLookupProficiencyObjectiveBankMappings()

Tests if this user can perform lookups of proficiency/objective bank mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeProficiencyObjectiveBankView

void useComparativeProficiencyObjectiveBankView()

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.

usePlenaryProficiencyObjectiveBankView

void usePlenaryProficiencyObjectiveBankView()

A complete view of the Proficiency and ObjectiveBank 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.

getProficiencyIdsByObjectiveBank

IdList getProficiencyIdsByObjectiveBank(Id objectiveBankId)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

Gets the list of Proficiency Ids associated with a ObjectiveBank.

Parameters:

objectiveBankId - Id of the ObjectiveBank

Returns:

list of related proficiency Ids

Throws:

NotFoundException - objectiveBankId is not found

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProficienciesByObjectiveBank

ProficiencyList getProficienciesByObjectiveBank(Id objectiveBankId)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Gets the list of Proficiencies associated with a ObjectiveBank.

Parameters:

objectiveBankId - Id of the ObjectiveBank

Returns:

list of related proficiencies

Throws:

NotFoundException - objectiveBankId is not found

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProficiencyIdsByObjectiveBanks

IdList getProficiencyIdsByObjectiveBanks(IdList objectiveBankIds)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Gets the list of Proficiency Ids corresponding to a list of ObjectiveBanks.

Parameters:

objectiveBankIds - list of objectiveBank Ids

Returns:

list of proficiency Ids

Throws:

NullArgumentException - objectiveBankIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProficienciesByObjectiveBanks

ProficiencyList getProficienciesByObjectiveBanks(IdList objectiveBankIds)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Gets the list of Proficiencies corresponding to a list of ObjectiveBanks.

Parameters:

objectiveBankIds - list of objectiveBank Ids

Returns:

list of proficiencies

Throws:

NullArgumentException - objectiveBankIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getObjectiveBankIdsByProficiency

IdList getObjectiveBankIdsByProficiency(Id proficiencyId)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

Gets the ObjectiveBank Ids mapped to a Proficiency.

Parameters:

proficiencyId - Id of a Proficiency

Returns:

list of objective banks

Throws:

NotFoundException - proficiencyId is not found

NullArgumentException - proficiencyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getObjectiveBanksByProficiency

ObjectiveBankList getObjectiveBanksByProficiency(Id proficiencyId)
                                                 throws NotFoundException,
                                                        OperationFailedException,
                                                        PermissionDeniedException

Gets the ObjectiveBanks mapped to a Proficiency.

Parameters:

proficiencyId - Id of a Proficiency

Returns:

list of objective banks

Throws:

NotFoundException - proficiencyId is not found

NullArgumentException - proficiencyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.