Interface ProcessEnablerLookupSession

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

This session provides methods for retrieving ProcessEnablers .

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 enabler methods in this session operate, retrieve and pertain to process enabler defined explicitly in the current office. Using an isolated view is useful for managing ProcessEnablers with the ProcessEnablerAdminSession .
  • federated office view: All process enabler methods in this session operate, retrieve and pertain to all process enabler defined in this office and any other process enabler implicitly available in this office through office inheritence.
  • active process enabler view: All process enabler lookup methods return active process enablers.
  • any status process enabler view: Process enablers of any active or inactive status are returned from methods.

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 the methods in this session.

  • 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.

    • canLookupProcessEnablers

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

    • useComparativeProcessEnablerView

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

    • usePlenaryProcessEnablerView

      void usePlenaryProcessEnablerView()
      A complete view of the ProcessEnabler 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 enabler in office 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 offices only.
      Compliance:
      mandatory - This method is must be implemented.

    • useActiveProcessEnablerView

      void useActiveProcessEnablerView()
      Only active process enablers are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusProcessEnablerView

      void useAnyStatusProcessEnablerView()
      All active and inactive process enablers are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getProcessEnabler

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

    • getProcessEnablersByIds

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

    • getProcessEnablersByGenusType

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

    • getProcessEnablersByParentGenusType

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

    • getProcessEnablersByRecordType

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

    • getProcessEnablersOnDate

      ProcessEnablerList getProcessEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a ProcessEnablerList that are effective for the entire given date range inclusive but not confined to the date range for any agent. In plenary mode, the returned list contains all known process enablers or an error results. Otherwise, the returned list may contain only those process enablers that are accessible through this session. In active mode, process enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive process enablers are returned.
      Parameters:
      from - a start date
      to - an end date
      Returns:
      the returned ProcessEnabler 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.

    • getProcessEnablersOnDateWithAgent

      ProcessEnablerList getProcessEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a ProcessEnablerList that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known process enablers or an error results. Otherwise, the returned list may contain only those process enablers that are accessible through this session. In active mode, process enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive process enablers are returned.
      Parameters:
      agentId - an agent Id
      from - a start date
      to - an end date
      Returns:
      the returned ProcessEnabler list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - agentId, from , or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProcessEnablers

      ProcessEnablerList getProcessEnablers() throws OperationFailedException, PermissionDeniedException
      Gets all ProcessEnablers . In plenary mode, the returned list contains all known process enabler or an error results. Otherwise, the returned list may contain only those process enabler that are accessible through this session. In active mode, process enablers are returned that are currently active. In any status mode, active and inactive process enablers are returned.
      Returns:
      the returned ProcessEnabler list
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.