Interface FoundryLookupSession

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

This session provides methods for retrieving Foundry objects. The Foundry represents a collection of jobs, work, availabilities, commissions, and efforts.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Foundries it can access, without breaking execution. However, an assessment may only be useful if all Foundries referenced by it are available, and a test-taking application may sacrifice some interoperability for the sake of precision.

  • Method Details

    • canLookupFoundries

      boolean canLookupFoundries()
      Tests if this user can perform Foundry lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeFoundryView

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

    • usePlenaryFoundryView

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

    • getFoundry

      Foundry getFoundry(Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Foundry specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Foundry may have a different Id than requested, such as the case where a duplicate Id was assigned to a Foundry and retained for compatibility.
      Parameters:
      foundryId - Id of the Foundry
      Returns:
      the foundry
      Throws:
      NotFoundException - foundryId not found
      NullArgumentException - foundryId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getFoundriesByIds

      FoundryList getFoundriesByIds(IdList foundryIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a FoundryList corresponding to the given IdList . In plenary mode, the returned list contains all of the foundries specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Foundries may be omitted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      foundryIds - the list of Ids to retrieve
      Returns:
      the returned Foundry list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - foundryIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getFoundriesByGenusType

      FoundryList getFoundriesByGenusType(Type foundryGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a FoundryList corresponding to the given foundry genus Type which does not include foundries of types derived from the specified Type .In plenary mode, the returned list contains all known foundries or an error results. Otherwise, the returned list may contain only those foundries that are accessible through this session.
      Parameters:
      foundryGenusType - a foundry genus type
      Returns:
      the returned Foundry list
      Throws:
      NullArgumentException - foundryGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getFoundriesByParentGenusType

      FoundryList getFoundriesByParentGenusType(Type foundryGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a FoundryList corresponding to the given foundry genus Type and include any additional foundries with genus types derived from the specified Type .In plenary mode, the returned list contains all known foundries or an error results. Otherwise, the returned list may contain only those foundries that are accessible through this session.
      Parameters:
      foundryGenusType - a foundry genus type
      Returns:
      the returned Foundry list
      Throws:
      NullArgumentException - foundryGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getFoundriesByRecordType

      FoundryList getFoundriesByRecordType(Type foundryRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a FoundryList containing the given foundry record Type . In plenary mode, the returned list contains all known foundries or an error results. Otherwise, the returned list may contain only those foundries that are accessible through this session.
      Parameters:
      foundryRecordType - a foundry record type
      Returns:
      the returned Foundry list
      Throws:
      NullArgumentException - foundryRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getFoundriesByProvider

      FoundryList getFoundriesByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Gets a FoundryList from the given provider. In plenary mode, the returned list contains all known foundries or an error results. Otherwise, the returned list may contain only those foundries that are accessible through this session.
      Parameters:
      resourceId - a resource Id
      Returns:
      the returned Foundry list
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getFoundries

      FoundryList getFoundries() throws OperationFailedException, PermissionDeniedException
      Gets all Foundries . In plenary mode, the returned list contains all known foundries or an error results. Otherwise, the returned list may contain only those foundries that are accessible through this session.
      Returns:
      a list of Foundries
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.