Interface RegistrationRequestLookupSession

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

This session provides methods for retrieving RegistrationReq uests.

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 request methods in this session operate, retrieve and pertain to registration requests defined explicitly in the current course catalog Using an isolated view is useful for managing RegistrationRe quests with the RegistrationRequestAdminSessio n.
  • federated registration request view: All registration request methods in this session operate, retrieve and pertain to all registration requests defined in this course catalog and any other registration requests 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.

    • canLookupRegistrationRequests

      boolean canLookupRegistrationRequests()
      Tests if this user can perform RegistrationR equest 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.

    • useComparativeRegistrationRequestView

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

    • usePlenaryRegistrationRequestView

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

    • getRegistrationRequest

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

    • getRegistrationRequestsByIds

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

    • getRegistrationRequestsByGenusType

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

    • getRegistrationRequestsByParentGenusType

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

    • getRegistrationRequestsByRecordType

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

    • getRegistrationRequestsByDate

      RegistrationRequestList getRegistrationRequestsByDate(Type registrationRequestRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a RegistrationRequestList submitted between the given date range inclusive. In plenary mode, the returned list contains all known registration requests or an error results. Otherwise, the returned list may contain only those registration requests that are accessible through this session.
      Parameters:
      registrationRequestRecordType - a registration request record type
      Returns:
      the returned RegistrationRequest list
      Throws:
      NullArgumentException - registrationRequestRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationRequestsByRequester

      RegistrationRequestList getRegistrationRequestsByRequester(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Gets a RegistrationRequestList by the requester. In plenary mode, the returned list contains all known registration requests or an error results. Otherwise, the returned list may contain only those registration requests that are accessible through this session.
      Parameters:
      resourceId - a resource Id
      Returns:
      the returned RegistrationRequest list
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationRequestsForTerm

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

    • getRegistrationRequestsByRequesterForTerm

      RegistrationRequestList getRegistrationRequestsByRequesterForTerm(Id resourceId, Id termId) throws OperationFailedException, PermissionDeniedException
      Gets a RegistrationRequestList by the requester for a given term. In plenary mode, the returned list contains all known registration requests or an error results. Otherwise, the returned list may contain only those registration requests that are accessible through this session.
      Parameters:
      resourceId - a resource Id
      termId - a term Id
      Returns:
      the returned RegistrationRequest list
      Throws:
      NullArgumentException - resourceId or termId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationRequests

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