Interface RenovationLookupSession

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

This session provides methods for retrieving Renovations . The Renovation represents a work project to a room or set of 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
  • isolated campus view: All renovation methods in this session operate, retrieve and pertain to renovations defined explicitly in the current campus. Using an isolated view is useful for managing renovations with the RenovationAdminSession .
  • federated campus view: All renovation lookup methods in this session operate, retrieve and pertain to all renovations defined in this campus and any other campuses implicitly available in this campus through campus inheritence.
  • effective renovation view: All renovation lookup methods return effective renovations.
  • any effective renovation view: Renovations of any effective date are returned.

  • Method Details

    • getCampusId

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

    • getCampus

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

    • canLookupRenovations

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

    • useComparativeRenovationView

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

    • usePlenaryRenovationView

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

    • useFederatedCampusView

      void useFederatedCampusView()
      Federates the view for methods in this session. A federated view will include renovations in campuses which are children of this campus in the campus hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedCampusView

      void useIsolatedCampusView()
      Isolates the view for methods in this session. An isolated view restricts retrievals to this campus only.
      Compliance:
      mandatory - This method is must be implemented.

    • useEffectiveRenovationView

      void useEffectiveRenovationView()
      Only renovations whose effective dates are current are returned by methods in this session
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyEffectiveRenovationView

      void useAnyEffectiveRenovationView()
      Renovations of any effective dates are returned by all methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getRenovation

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

    • getRenovationsByIds

      RenovationList getRenovationsByIds(IdList renovationIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a RenovationList corresponding to the given IdList . In plenary mode, the returned list contains all of the renovations 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 Renovations may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned.
      Parameters:
      renovationIds - the list of Ids to retrieve
      Returns:
      the returned Renovation list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - renovationIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRenovationsByGenusType

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

    • getRenovationsByParentGenusType

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

    • getRenovationsByRecordType

      RenovationList getRenovationsByRecordType(Type renovationRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a RenovationList containing the given renovation record Type . In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned.
      Parameters:
      renovationRecordType - a renovation record type
      Returns:
      the returned Renovation list
      Throws:
      NullArgumentException - renovationRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRenovationsOnDate

      RenovationList getRenovationsOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a list of all renovations effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned.
      Parameters:
      from - start of date range
      to - end of date range
      Returns:
      the returned RenovationList
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRenovationsByGenusTypeOnDate

      RenovationList getRenovationsByGenusTypeOnDate(Type renovationGenusType, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a list of all renovations of a genus type effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned.
      Parameters:
      renovationGenusType - a renovation genus type
      from - start of date range
      to - end of date range
      Returns:
      the returned RenovationList
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - renovationGenusType, from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRenovationsForRoom

      RenovationList getRenovationsForRoom(Id roomId) throws OperationFailedException, PermissionDeniedException
      Gets a list of all renovations corresponding to a room Id . In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned.
      Parameters:
      roomId - the Id of the room
      Returns:
      the returned RenovationList
      Throws:
      NullArgumentException - roomId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRenovationsByGenusTypeForRoom

      RenovationList getRenovationsByGenusTypeForRoom(Id roomId, Type renovationGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a list of all renovations corresponding to a room and renovation genus type. In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned.
      Parameters:
      roomId - a room Id
      renovationGenusType - a renovation genus type
      Returns:
      the returned RenovationList
      Throws:
      InvalidArgumentException - to is less than from
      NullArgumentException - roomId or renovationGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRenovationsForRoomOnDate

      RenovationList getRenovationsForRoomOnDate(Id roomId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a list of all renovations for a room with an effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned.
      Parameters:
      roomId - a room Id
      from - start of date range
      to - end of date range
      Returns:
      the returned RenovationList
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - roomId, from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRenovationsByGenusTypeForRoomOnDate

      RenovationList getRenovationsByGenusTypeForRoomOnDate(Id roomId, Type renovationGenusType, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a list of all renovations for a room and of a renovation genus type effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned.
      Parameters:
      roomId - a room Id
      renovationGenusType - a renovation genus type
      from - start of date range
      to - end of date range
      Returns:
      the returned RenovationList
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - roomId, renovationGenusType, from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRenovationsForFloor

      RenovationList getRenovationsForFloor(Id floorId) throws OperationFailedException, PermissionDeniedException
      Gets a list of all renovations on a floor Id . In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned.
      Parameters:
      floorId - the Id of the floor
      Returns:
      the returned RenovationList
      Throws:
      NullArgumentException - floorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRenovationsByGenusTypeForFloor

      RenovationList getRenovationsByGenusTypeForFloor(Id floorId, Type renovationGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a list of all renovations on a floor and of a renovation genus type. In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned.
      Parameters:
      floorId - a floor Id
      renovationGenusType - a renovation genus type
      Returns:
      the returned RenovationList
      Throws:
      InvalidArgumentException - to is less than from
      NullArgumentException - floorId or renovationGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRenovationsForFloorOnDate

      RenovationList getRenovationsForFloorOnDate(Id floorId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a list of all renovations on a floor with an effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned.
      Parameters:
      floorId - a floor Id
      from - start of date range
      to - end of date range
      Returns:
      the returned RenovationList
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - floorId, from , or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRenovationsByGenusTypeForFloorOnDate

      RenovationList getRenovationsByGenusTypeForFloorOnDate(Id floorId, Type renovationGenusType, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a list of all renovations on a floor and of a renovation genus type effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned.
      Parameters:
      floorId - a floor Id
      renovationGenusType - a renovation genus type
      from - start of date range
      to - end of date range
      Returns:
      the returned RenovationList
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - floorId, renovationGenusType, from ,or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRenovationsForBuilding

      RenovationList getRenovationsForBuilding(Id buildingId) throws OperationFailedException, PermissionDeniedException
      Gets a list of all renovations in a building. In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned.
      Parameters:
      buildingId - the Id of the building
      Returns:
      the returned RenovationList
      Throws:
      NullArgumentException - buildingId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRenovationsByGenusTypeForBuilding

      RenovationList getRenovationsByGenusTypeForBuilding(Id buildingId, Type renovationGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a list of all renovations in a building and of a renovation genus type. In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned.
      Parameters:
      buildingId - a building Id
      renovationGenusType - a renovation genus type
      Returns:
      the returned RenovationList
      Throws:
      InvalidArgumentException - to is less than from
      NullArgumentException - buildingId or renovationGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRenovationsForBuildingOnDate

      RenovationList getRenovationsForBuildingOnDate(Id buildingId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a list of all renovations in a building with an effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned.
      Parameters:
      buildingId - a building Id
      from - start of date range
      to - end of date range
      Returns:
      the returned RenovationList
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - buildingId, from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRenovationsByGenusTypeForBuildingOnDate

      RenovationList getRenovationsByGenusTypeForBuildingOnDate(Id buildingId, Type renovationGenusType, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a list of all renovations in a building and of a renovation genus type effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned.
      Parameters:
      buildingId - a building Id
      renovationGenusType - a renovation genus type
      from - start of date range
      to - end of date range
      Returns:
      the returned RenovationList
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - buildingId, renovationGenusType, from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRenovations

      RenovationList getRenovations() throws OperationFailedException, PermissionDeniedException
      Gets all Renovations . In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned.
      Returns:
      a list of Renovations
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.