Interface ProcessLookupSession

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

This session provides methods for retrieving Process objects. The Process represents a collection states.

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

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Processes it can access, without breaking execution. However, an administrative application may require all Process elements to be available.

Processes may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Process .

  • Method Details

    • canLookupProcesses

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

    • useComparativeProcessView

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

    • usePlenaryProcessView

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

    • getProcess

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

    • getProcessesByIds

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

    • getProcessesByGenusType

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

    • getProcessesByParentGenusType

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

    • getProcessesByRecordType

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

    • getProcessesByProvider

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

    • getProcesses

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