Interface ProcessProcessorEnablerOfficeSession

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

This session provides methods to retrieve ProcessprocessorEnabler to Office mappings. A ProcessProcessorEnabler may appear in multiple Offices. Each office may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition

  • Method Details

    • canLookupProcessProcessorEnablerOfficeMappings

      boolean canLookupProcessProcessorEnablerOfficeMappings()
      Tests if this user can perform lookups of process processor enabler/office mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. T his is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
      Returns:
      false if looking up mappings is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeProcessProcessorEnablerOfficeView

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

    • usePlenaryProcessProcessorEnablerOfficeView

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

    • getProcessProcessorEnablerIdsByOffice

      IdList getProcessProcessorEnablerIdsByOffice(Id officeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of ProcessProcessorEnablerIds associated with an Office .
      Parameters:
      officeId - Id of the Office
      Returns:
      list of related process processor enabler Ids
      Throws:
      NotFoundException - officeId is not found
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProcessProcessorEnablersByOffice

      ProcessProcessorEnablerList getProcessProcessorEnablersByOffice(Id officeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of ProcessProcessorEnablers associated with an Office .
      Parameters:
      officeId - Id of the Office
      Returns:
      list of related process processor enablers
      Throws:
      NotFoundException - officeId is not found
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProcessProcessorEnablerIdsByOffices

      IdList getProcessProcessorEnablerIdsByOffices(IdList officeIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of ProcessProcessorEnablerIds corresponding to a list of Offices .
      Parameters:
      officeIds - list of office Ids
      Returns:
      list of process processor enabler Ids
      Throws:
      NullArgumentException - officeIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProcessProcessorEnablersByOffices

      ProcessProcessorEnablerList getProcessProcessorEnablersByOffices(IdList officeIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of ProcessProcessorEnablers corresponding to a list of Offices .
      Parameters:
      officeIds - list of office Ids
      Returns:
      list of process processor enablers
      Throws:
      NullArgumentException - officeIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getOfficeIdsByProcessProcessorEnabler

      IdList getOfficeIdsByProcessProcessorEnabler(Id processProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Office Ids mapped to a ProcessProcessorEnabler .
      Parameters:
      processProcessorEnablerId - Id of a ProcessProcessorEnabler
      Returns:
      list of office Ids
      Throws:
      NotFoundException - processProcessorEnablerId is not found
      NullArgumentException - processProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getOfficesByProcessProcessorEnabler

      OfficeList getOfficesByProcessProcessorEnabler(Id processProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Offices mapped to a ProcessProcessorEnabler .
      Parameters:
      processProcessorEnablerId - Id of a ProcessProcessorEnabler
      Returns:
      list of offices
      Throws:
      NotFoundException - processProcessorEnablerId is not found
      NullArgumentException - processProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.