Interface AwardAcademySession
- All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
This session provides methods to retrieve Award to
Academy mappings. An Award may appear in multiple
Academies . Each Academy 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
Modifier and TypeMethodDescriptionbooleanTests if this user can perform lookups of award/academy mappings.getAcademiesByAward(Id awardId) Gets the list ofAcademyobjects mapped to anAward.getAcademyIdsByAward(Id awardId) Gets the list ofAcademyIdsmapped to anAward.getAwardIdsByAcademies(IdList academyIds) Gets the list ofAward Idscorresponding to a list ofAcademyobjects.getAwardIdsByAcademy(Id academyId) Gets the list of Award Ids associated with anAcademy.getAwardsByAcademies(IdList academyIds) Gets the list ofAwardscorresponding to a list ofAcademies.getAwardsByAcademy(Id academyId) Gets the list ofAwardsassociated with anAcademy.voidThe returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.voidA complete view of theAwardandAcademyreturns is desired.Methods inherited from interface OsidSession
closeMethods inherited from interface OsidSession
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactionsModifier and TypeMethodDescriptionGets the agent authenticated to this session.Gets theIdof the agent authenticated to this session.Gets the rate of the service clock.getDate()Gets the service date which may be the current date or the effective date in which this session exists.Gets the effective agent in use by this session.Gets theIdof the effective agent in use by this session.Gets theDisplayTextformatTypepreference in effect for this session.Gets the locale indicating the localization preferences in effect for this session.booleanTests if an agent is authenticated to this session.Starts a new transaction for this sesson.booleanTests for the availability of transactions.
-
Method Details
-
canLookupAwardAcademyMappings
boolean canLookupAwardAcademyMappings()Tests if this user can perform lookups of award/academy 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 aPERMISSION_DENIED. This is intendedas a hint to an application that may opt not to offer lookup operations to unauthorized users.- Returns:
falseif looking up mappings is not authorized,trueotherwise- Compliance:
mandatory- This method must be implemented.
-
useComparativeAcademyView
void useComparativeAcademyView()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.
-
usePlenaryAcademyView
void usePlenaryAcademyView()A complete view of theAwardandAcademyreturns 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.
-
getAwardIdsByAcademy
IdList getAwardIdsByAcademy(Id academyId) throws NotFoundException, OperationFailedException, PermissionDeniedException Gets the list of Award Ids associated with anAcademy.- Parameters:
academyId-Idof anAcademy.- Returns:
- list of related award
Ids - Throws:
NotFoundException-academyIdis not foundNullArgumentException-academyIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
getAwardsByAcademy
AwardList getAwardsByAcademy(Id academyId) throws NotFoundException, OperationFailedException, PermissionDeniedException Gets the list ofAwardsassociated with anAcademy.- Parameters:
academyId-Idof anAcademy- Returns:
- list of related awards
- Throws:
NotFoundException-academyIdis not foundNullArgumentException-academyIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
getAwardIdsByAcademies
IdList getAwardIdsByAcademies(IdList academyIds) throws OperationFailedException, PermissionDeniedException Gets the list ofAward Idscorresponding to a list ofAcademyobjects.- Parameters:
academyIds- list of academyIds- Returns:
- list of award
Ids - Throws:
NullArgumentException-academyIdsisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
getAwardsByAcademies
AwardList getAwardsByAcademies(IdList academyIds) throws OperationFailedException, PermissionDeniedException Gets the list ofAwardscorresponding to a list ofAcademies.- Parameters:
academyIds- list of academyIds- Returns:
- list of awards
- Throws:
NullArgumentException-academyIdsisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
getAcademyIdsByAward
IdList getAcademyIdsByAward(Id awardId) throws NotFoundException, OperationFailedException, PermissionDeniedException Gets the list ofAcademyIdsmapped to anAward.- Parameters:
awardId-Idof anAward- Returns:
- list of academy
Ids - Throws:
NotFoundException-awardIdis not foundNullArgumentException-awardIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
getAcademiesByAward
AcademyList getAcademiesByAward(Id awardId) throws NotFoundException, OperationFailedException, PermissionDeniedException Gets the list ofAcademyobjects mapped to anAward.- Parameters:
awardId-Idof anAward- Returns:
- list of academies
- Throws:
NotFoundException-awardIdis not foundNullArgumentException-awardIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-