Interface CampusLookupSession

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

This session provides methods for retrieving Campuses . The Campus represents a collection of disptches and rooms.

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

  • Method Details

    • canLookupCampuses

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

    • useComparativeCampusView

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

    • usePlenaryCampusView

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

    • getCampus

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

    • getCampusesByIds

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

    • getCampusesByGenusType

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

    • getCampusesByParentGenusType

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

    • getCampusesByRecordType

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

    • getCampusesByProvider

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

    • getCampuses

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