Interface AwardLookupSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface AwardLookupSession extends OsidSession

This session provides methods for retrieving Awards . The Award represents a collection of conferrals.

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 view or is an error condition
  • isolated academy view: All award methods in this session operate, retrieve and pertain to awards defined explicitly in the current academy. Using an isolated view is useful for managing awards with the AwardAdminSession .
  • federated academy view: All award lookup methods in this session operate, retrieve and pertain to all awards defined in this academy and any other academies implicitly available in this academy through academy inheritence.

  • Method Details

    • getAcademyId

      Id getAcademyId()
      Gets the Academy Id associated with this session.
      Returns:
      the Academy Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getAcademy

      Academy getAcademy() throws OperationFailedException, PermissionDeniedException
      Gets the Academy associated with this session.
      Returns:
      the academy
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canLookupAwards

      boolean canLookupAwards()
      Tests if this user can perform Award 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.

    • useComparativeAwardView

      void useComparativeAwardView()
      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.

    • usePlenaryAwardView

      void usePlenaryAwardView()
      A complete view of the Award 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.

    • useFederatedAcademyView

      void useFederatedAcademyView()
      Federates the view for methods in this session. A federated view will include awards in academies which are children of this academy in the academy hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedAcademyView

      void useIsolatedAcademyView()
      Isolates the view for methods in this session. An isolated view restricts retrievals to this academy only.
      Compliance:
      mandatory - This method is must be implemented.

    • getAward

      Award getAward(Id awardId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Award specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Award may have a different Id than requested, such as the case where a duplicate Id was assigned to an Award and retained for compatibility.
      Parameters:
      awardId - Id of the Award
      Returns:
      the award
      Throws:
      NotFoundException - awardId not found
      NullArgumentException - awardId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getAwardsByIds

      AwardList getAwardsByIds(IdList awardIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets an AwardList corresponding to the given IdList . In plenary mode, the returned list contains all of the awards 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 Awards may be omitted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      awardIds - the list of Ids to retrieve
      Returns:
      the returned Award list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - awardIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAwardsByGenusType

      AwardList getAwardsByGenusType(Type awardGenusType) throws OperationFailedException, PermissionDeniedException
      Gets an AwardList corresponding to the given award genus Type which does not include awards of genus types derived from the specified Type . In plenary mode, the returned list contains all known awards or an error results. Otherwise, the returned list may contain only those awards that are accessible through this session.
      Parameters:
      awardGenusType - an award genus type
      Returns:
      the returned Award list
      Throws:
      NullArgumentException - awardGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAwardsByParentGenusType

      AwardList getAwardsByParentGenusType(Type awardGenusType) throws OperationFailedException, PermissionDeniedException
      Gets an AwardList corresponding to the given award genus Type and include any additional awards with genus types derived from the specified Type . In plenary mode, the returned list contains all known awards or an error results. Otherwise, the returned list may contain only those awards that are accessible through this session.
      Parameters:
      awardGenusType - an award genus type
      Returns:
      the returned Award list
      Throws:
      NullArgumentException - awardGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAwardsByRecordType

      AwardList getAwardsByRecordType(Type awardRecordType) throws OperationFailedException, PermissionDeniedException
      Gets an AwardList containing the given award record Type . In plenary mode, the returned list contains all known awards or an error results. Otherwise, the returned list may contain only those awards that are accessible through this session.
      Parameters:
      awardRecordType - an award record type
      Returns:
      the returned Award list
      Throws:
      NullArgumentException - awardRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAwards

      AwardList getAwards() throws OperationFailedException, PermissionDeniedException
      Gets all Awards . In plenary mode, the returned list contains all known awards or an error results. Otherwise, the returned list may contain only those awards that are accessible through this session.
      Returns:
      a list of Awards
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.