Interface ObjectiveLookupSession

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

This session provides methods for retrieving Objective s.

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
  • isolated objective bank view: All objective methods in this session operate, retrieve and pertain to objectives defined explicitly in the current objective bank. Using an isolated view is useful for managing objectives with the ObjectiveAdminSession .
  • federated objective bank view: All objective methods in this session operate, retrieve and pertain to all objectives defined in this objective bank and any other objective banks implicitly available in this objective bank through objective bank inheritence.

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

  • Method Details

    • getObjectiveBankId

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

    • getObjectiveBank

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

    • canLookupObjectives

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

    • useComparativeObjectiveView

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

    • usePlenaryObjectiveView

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

    • useFederatedObjectiveBankView

      void useFederatedObjectiveBankView()
      Federates the view for methods in this session. A federated view will include objectives in objective banks which are children of this objective bank in the objective bank hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedObjectiveBankView

      void useIsolatedObjectiveBankView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this objective bank only.
      Compliance:
      mandatory - This method is must be implemented.

    • getObjective

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

    • getObjectivesByIds

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

    • getObjectivesByGenusType

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

    • getObjectivesByParentGenusType

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

    • getObjectivesByRecordType

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

    • getObjectives

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