Interface BusinessLookupSession

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

This session provides methods for retrieving Businesses . The Business represents a collection of customers, offerings and tems.

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 Businesses it can access, without breaking execution. However, an assessment may only be useful if all Businesses referenced by it are available, and a test-taking application may sacrifice some interoperability for the sake of precision.

  • Method Details

    • canLookupBusinesses

      boolean canLookupBusinesses()
      Tests if this user can perform Business 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.

    • useComparativeBusinessView

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

    • usePlenaryBusinessView

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

    • getBusiness

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

    • getBusinessesByIds

      BusinessList getBusinessesByIds(IdList businessIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a BusinessList corresponding to the given IdList . In plenary mode, the returned list contains all of the businesses 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 Businesses may be omitted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      businessIds - the list of Ids to retrieve
      Returns:
      the returned Business list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - businessIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBusinessesByGenusType

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

    • getBusinessesByParentGenusType

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

    • getBusinessesByRecordType

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

    • getBusinessesByProvider

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

    • getBusinesses

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