Interface PathLookupSession

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

This session provides methods for retrieving Path objects. The Path represents a fixed connection between two Locations .

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 map view: All path methods in this session operate, retrieve and pertain to paths defined explicitly in the current map. Using an isolated view is useful for managing Paths with the PathAdminSession .
  • federated map view: All path methods in this session operate, retrieve and pertain to all paths defined in this map and any other paths implicitly available in this map through map 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 useFederatedMapView() and useIsolatedMapView() behave as a radio group and one should be selected before invoking any lookup methods.

  • Method Details

    • getMapId

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

    • getMap

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

    • canLookupPaths

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

    • useComparativePathView

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

    • usePlenaryPathView

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

    • useFederatedMapView

      void useFederatedMapView()
      Federates the view for methods in this session. A federated view will include paths in maps which are children of this map in the map hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedMapView

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

    • getPath

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

    • getPathsByIds

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

    • getPathsByGenusType

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

    • getPathsByParentGenusType

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

    • getPathsByRecordType

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

    • getPathsAlongLocations

      PathList getPathsAlongLocations(IdList locationIds) throws OperationFailedException, PermissionDeniedException
      Gets a PathList connected to all the given Locations . In plenary mode, the returned list contains all of the paths along the locations, or an error results if a path connected to the location is not found or inaccessible. Otherwise, inaccessible Paths may be omitted from the list.
      Parameters:
      locationIds - the list of Ids to retrieve
      Returns:
      the returned Path list
      Throws:
      NullArgumentException - locationIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getPaths

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