Interface DeedLookupSession

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

This session provides methods for retrieving Deeds . The Deed represents a relationship between an owner and a building.

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 room methods in this session operate, retrieve and pertain to deeds defined explicitly in the current campus. Using an isolated view is useful for managing deeds with the DeedAdminSession .
  • federated campus view: All deed lookup methods in this session operate, retrieve and pertain to all deeds defined in this campus and any other campuses implicitly available in this campus through campus inheritence.
  • effective deed view: All deed lookup methods return effective deeds.
  • any effective deed view: deeds 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.

    • canLookupDeeds

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

    • useComparativeDeedView

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

    • usePlenaryDeedView

      void usePlenaryDeedView()
      A complete view of the Deed 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 deeds 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.

    • useEffectiveDeedView

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

    • useAnyEffectiveDeedView

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

    • getDeed

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

    • getDeedsByIds

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

    • getDeedsByGenusType

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

    • getDeedsByParentGenusType

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

    • getDeedsByRecordType

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

    • getDeedsOnDate

      DeedList getDeedsOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a list of all deeds effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known deeds or an error results. Otherwise, the returned list may contain only those deeds that are accessible through this session. In effective mode, deeds are returned that are currently effective. In any effective mode, effective deeds and those currently expired are returned.
      Parameters:
      from - start of date range
      to - end of date range
      Returns:
      the returned Deed list
      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.

    • getDeedsByGenusTypeOnDate

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

    • getDeedsForBuilding

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

    • getDeedsByGenusTypeForBuilding

      DeedList getDeedsByGenusTypeForBuilding(Id buildingId, Type deedGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a DeedList containing the given building and genus type. In plenary mode, the returned list contains all known deeds or an error results. Otherwise, the returned list may contain only those deeds that are accessible through this session. In effective mode, deeds are returned that are currently effective. In any effective mode, effective deeds and those currently expired are returned.
      Parameters:
      buildingId - a building Id
      deedGenusType - a deed genus type
      Returns:
      the returned Deed list
      Throws:
      NullArgumentException - buildingId or deedGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getDeedsForBuildingOnDate

      DeedList getDeedsForBuildingOnDate(Id buildingId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a list of all deeds for a building effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known deeds or an error results. Otherwise, the returned list may contain only those deeds that are accessible through this session. In effective mode, deeds are returned that are currently effective. In any effective mode, effective deeds and those currently expired are returned.
      Parameters:
      buildingId - a building Id
      from - start of date range
      to - end of date range
      Returns:
      the returned Deed list
      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.

    • getDeedsByGenusTypeForBuildingOnDate

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

    • getDeedsForOwner

      DeedList getDeedsForOwner(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Gets a DeedList containing the given owner resource. In plenary mode, the returned list contains all known deeds or an error results. Otherwise, the returned list may contain only those deeds that are accessible through this session. In effective mode, deeds are returned that are currently effective. In any effective mode, effective deeds and those currently expired are returned.
      Parameters:
      resourceId - a resource Id
      Returns:
      the returned Deed list
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getDeedsByGenusTypeForOwner

      DeedList getDeedsByGenusTypeForOwner(Id resourceId, Type deedGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a DeedList containing the given owner and genus type. In plenary mode, the returned list contains all known deeds or an error results. Otherwise, the returned list may contain only those deeds that are accessible through this session. In effective mode, deeds are returned that are currently effective. In any effective mode, effective deeds and those currently expired are returned.
      Parameters:
      resourceId - a resource Id
      deedGenusType - a deed genus type
      Returns:
      the returned Deed list
      Throws:
      NullArgumentException - resourceId or deedGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getDeedsForOwnerOnDate

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

    • getDeedsByGenusTypeForOwnerOnDate

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

    • getDeedsForBuildingAndOwner

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

    • getDeedsByGenusTypeForBuildingAndOwner

      DeedList getDeedsByGenusTypeForBuildingAndOwner(Id buildingId, Id resourceId, Type deedGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a DeedList for the given building, owner, and genus type. In plenary mode, the returned list contains all known deeds or an error results. Otherwise, the returned list may contain only those deeds that are accessible through this session. In effective mode, deeds are returned that are currently effective. In any effective mode, effective deeds and those currently expired are returned.
      Parameters:
      buildingId - a building Id
      resourceId - a resource Id
      deedGenusType - a deed genus type
      Returns:
      the returned Deed list
      Throws:
      NullArgumentException - buildingId, resourceId , or deedGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getDeedsForBuildingAndOwnerOnDate

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

    • getDeedsByGenusTypeForBuildingAndOwnerOnDate

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

    • getDeeds

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