Interface RegistrationTargetLookupSession

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

This session provides methods for retrieving RegistrationTar gets.

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 course catalog view: All registration target methods in this session operate, retrieve and pertain to registration targets defined explicitly in the current course catalog Using an isolated view is useful for managing RegistrationTa rgets with the RegistrationTargetAdminSession .
  • federated registration target view: All registration target methods in this session operate, retrieve and pertain to all registration targets defined in this course catalog and any other registration targets implicitly available in this course catalog through course catalog inheritence.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedCourseCatalogView() and useIsolatedCourseCatalogView() behave as a radio group and one should be selected before invoking any lookup methods.

  • Method Details

    • getCourseCatalogId

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

    • getCourseCatalog

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

    • canLookupRegistrationTargets

      boolean canLookupRegistrationTargets()
      Tests if this user can perform RegistrationT arget 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.

    • useComparativeRegistrationTargetView

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

    • usePlenaryRegistrationTargetView

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

    • useFederatedCourseCatalogView

      void useFederatedCourseCatalogView()
      Federates the view for methods in this session. A federated view will include registration targets in course catalogs which are children of this course catalog in the course catalog hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedCourseCatalogView

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

    • getRegistrationTarget

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

    • getRegistrationTargetsByIds

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

    • getRegistrationTargetsByGenusType

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

    • getRegistrationTargetsByParentGenusType

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

    • getRegistrationTargetsByRecordType

      RegistrationTargetList getRegistrationTargetsByRecordType(Type registrationTargetRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a RegistrationTarge tList containing the given registration target record Type . In plenary mode, the returned list contains all known registration targets or an error results. Otherwise, the returned list may contain only those registration targets that are accessible through this session.
      Parameters:
      registrationTargetRecordType - a registration target record type
      Returns:
      the returned RegistrationTarget list
      Throws:
      NullArgumentException - registrationTargetRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationTargetsForCourseOffering

      RegistrationTargetList getRegistrationTargetsForCourseOffering(Id courseOfferingId) throws OperationFailedException, PermissionDeniedException
      Gets a RegistrationTargetList for a given course offering. In plenary mode, the returned list contains all known registration targets or an error results. Otherwise, the returned list may contain only those registration targets that are accessible through this session.
      Parameters:
      courseOfferingId - a course offering Id
      Returns:
      the returned RegistrationTargetList
      Throws:
      NullArgumentException - courseOfferingId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationTargetsByActivity

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

    • getRegistrationTargets

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