Interface ProcessConstrainerEnablerOfficeSession

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

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

    • canLookupProcessConstrainerEnablerOfficeMappings

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

    • useComparativeProcessConstrainerEnablerOfficeView

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

    • usePlenaryProcessConstrainerEnablerOfficeView

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

    • getProcessConstrainerEnablerIdsByOffice

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

    • getProcessConstrainerEnablersByOffice

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

    • getProcessConstrainerEnablerIdsByOffices

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

    • getProcessConstrainerEnablersByOffices

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

    • getOfficeIdsByProcessConstrainerEnabler

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

    • getOfficesByProcessConstrainerEnabler

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