Interface JobConstrainerEnablerFoundrySession

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

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

    • canLookupJobConstrainerEnablerFoundryMappings

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

    • useComparativeJobConstrainerEnablerFoundryView

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

    • usePlenaryJobConstrainerEnablerFoundryView

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

    • getJobConstrainerEnablerIdsByFoundry

      IdList getJobConstrainerEnablerIdsByFoundry(Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of JobConstrainerEnablerIds associated with a Foundry .
      Parameters:
      foundryId - Id of the Foundry
      Returns:
      list of related job constrainer 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.

    • getJobConstrainerEnablersByFoundry

      JobConstrainerEnablerList getJobConstrainerEnablersByFoundry(Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of job constrainer enablers associated with a Foundry .
      Parameters:
      foundryId - Id of the Foundry
      Returns:
      list of related job constrainer 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.

    • getJobConstrainerEnablerIdsByFoundries

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

    • getJobConstrainerEnablersByFoundries

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

    • getFoundryIdsByJobConstrainerEnabler

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

    • getFoundrysByJobConstrainerEnabler

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