Interface ProcessConstrainerOfficeSession

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

This session provides methods to retrieve ProcessConstrainer to Office mappings. A ProcessConstrainer 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

    • canLookupProcessConstrainerOfficeMappings

      boolean canLookupProcessConstrainerOfficeMappings()
      Tests if this user can perform lookups of process constrainer/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.

    • useComparativeProcessConstrainerOfficeView

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

    • usePlenaryProcessConstrainerOfficeView

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

    • getProcessConstrainerIdsByOffice

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

    • getProcessConstrainersByOffice

      ProcessConstrainerList getProcessConstrainersByOffice(Id officeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of ProcessConstrainers associated with an Office .
      Parameters:
      officeId - Id of the Office
      Returns:
      list of related process constrainers
      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.

    • getProcessConstrainerIdsByOffices

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

    • getProcessConstrainersByOffices

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

    • getOfficeIdsByProcessConstrainer

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

    • getOfficesByProcessConstrainer

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