Interface JobProcessorEnablerFoundrySession

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

This session provides methods to retrieve JobProcessorEnabler to Foundry mappings. A JobProcessorEnabler may appear in multiple Foundry objects. Each foundry 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

    • canLookupJobProcessorEnablerFoundryMappings

      boolean canLookupJobProcessorEnablerFoundryMappings()
      Tests if this user can perform lookups of job processor enabler/foundry 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.

    • useComparativeJobProcessorEnablerFoundryView

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

    • usePlenaryJobProcessorEnablerFoundryView

      void usePlenaryJobProcessorEnablerFoundryView()
      A complete view of the JobProcessorEnabler and Foundry 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.

    • getJobProcessorEnablerIdsByFoundry

      IdList getJobProcessorEnablerIdsByFoundry(Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of JobProcessorEnablerIds associated with a Foundry .
      Parameters:
      foundryId - Id of the Foundry
      Returns:
      list of related job processor enabler Ids
      Throws:
      NotFoundException - foundryId is not found
      NullArgumentException - foundryId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getJobProcessorEnablersByFoundry

      JobProcessorEnablerList getJobProcessorEnablersByFoundry(Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of job processor enablers associated with a Foundry .
      Parameters:
      foundryId - Id of the Foundry
      Returns:
      list of related job processor enablers
      Throws:
      NotFoundException - foundryId is not found
      NullArgumentException - foundryId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getJobProcessorEnablerIdsByFoundries

      IdList getJobProcessorEnablerIdsByFoundries(IdList foundryIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of JobProcessorEnablerIds corresponding to a list of Foundries .
      Parameters:
      foundryIds - list of foundry Ids
      Returns:
      list of job processor enabler Ids
      Throws:
      NullArgumentException - foundryIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getJobProcessorEnablersByFoundries

      JobProcessorEnablerList getJobProcessorEnablersByFoundries(IdList foundryIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of job processor enablers corresponding to a list of Foundries .
      Parameters:
      foundryIds - list of foundry Ids
      Returns:
      list of job processor enablers
      Throws:
      NullArgumentException - foundryIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getFoundryIdsByJobProcessorEnabler

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

    • getFoundrysByJobProcessorEnabler

      FoundryList getFoundrysByJobProcessorEnabler(Id jobProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Foundries mapped to a JobProcessorEnabler .
      Parameters:
      jobProcessorEnablerId - Id of a JobProcessorEnabler
      Returns:
      list of foundries
      Throws:
      NotFoundException - jobProcessorEnablerId is not found
      NullArgumentException - jobProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.