Interface StepProcessorEnablerOfficeSession

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

This session provides methods to retrieve StepProcessorEnabler to Office mappings. a StepProcessorEnabler may appear in multiple Office objects. 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

    • canLookupStepProcessorEnablerOfficeMappings

      boolean canLookupStepProcessorEnablerOfficeMappings()
      Tests if this user can perform lookups of step 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 . This 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.

    • useComparativeStepProcessorEnablerOfficeView

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

    • usePlenaryStepProcessorEnablerOfficeView

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

    • getStepProcessorEnablerIdsByOffice

      IdList getStepProcessorEnablerIdsByOffice(Id officeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of StepProcessorEnablerIds associated with an Office .
      Parameters:
      officeId - Id of the Office
      Returns:
      list of related step 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.

    • getStepProcessorEnablersByOffice

      StepProcessorEnablerList getStepProcessorEnablersByOffice(Id officeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of step processor enablers associated with an Office .
      Parameters:
      officeId - Id of the Office
      Returns:
      list of related step 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.

    • getStepProcessorEnablerIdsByOffices

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

    • getStepProcessorEnablersByOffices

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

    • getOfficeIdsByStepProcessorEnabler

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

    • getOfficesByStepProcessorEnabler

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