Interface ProcessProcessorEnablerLookupSession

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

This session provides methods for retrieving ProcessProcessorEnablers .

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 office view: All process processor enabler methods in this session operate, retrieve and pertain to process processor enablers defined explicitly in the current office Using an isolated view is useful for managing ProcessProcessorEnablers with the ProcessProcessorEnablerAdminSession .
  • federated office view: All process processor enabler methods in this session operate, retrieve and pertain to all process processor enablers defined in this office and any other process processor enablers implicitly available in this office through office 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 useFederatedOfficeView() and useIsolatedOfficeView() behave as a radio group and one should be selected before invoking any lookup methods.

  • Method Details

    • getOfficeId

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

    • getOffice

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

    • canLookupProcessProcessorEnablers

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

    • useComparativeProcessProcessorEnablerView

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

    • usePlenaryProcessProcessorEnablerView

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

    • useFederatedOfficeView

      void useFederatedOfficeView()
      Federates the view for methods in this session. A federated view will include process processor enablers in offices which are children of this office in the office hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedOfficeView

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

    • getProcessProcessorEnabler

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

    • getProcessProcessorEnablersByIds

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

    • getProcessProcessorEnablersByGenusType

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

    • getProcessProcessorEnablersByParentGenusType

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

    • getProcessProcessorEnablersByRecordType

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

    • getProcessProcessorEnablers

      ProcessProcessorEnablerList getProcessProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Gets all ProcessProcessorEnablers . In plen ary mode, the returned list contains all known process processor enablers or an error results. Otherwise, the returned list may contain only those process processor enablers that are accessible through this session.
      Returns:
      a list of ProcessProcessorEnablers
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.