Interface ObjectiveBankLookupSession

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

This session provides methods for retrieving ObjectiveBanks . The ObjectiveBank represents a collection of Objectives Activities , and Proficiencies .

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 set or is an error condition

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the ObjectiveBanks it can access, without breaking execution. However, an administrative application may require all ObjectiveBank elements to be available.

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

  • Method Details

    • canLookupObjectiveBanks

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

    • useComparativeObjectiveBankView

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

    • usePlenaryObjectiveBankView

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

    • getObjectiveBank

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

    • getObjectiveBanksByIds

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

    • getObjectiveBanksByGenusType

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

    • getObjectiveBanksByParentGenusType

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

    • getObjectiveBanksByRecordType

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

    • getObjectiveBanksByProvider

      ObjectiveBankList getObjectiveBanksByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Gets a ObjectiveBankList for the given provider. In plenary mode, the returned list contains all known objective banks or an error results. Otherwise, the returned list may contain only those objective banks that are accessible through this session.
      Parameters:
      resourceId - a resource Id
      Returns:
      the returned ObjectiveBank list
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getObjectiveBanks

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