Interface OsidSourceableQuery

All Superinterfaces:
OsidQuery, Suppliable
All Known Subinterfaces:
AcademyQuery, AddressBookQuery, AgencyQuery, AntimatroidQuery, AssetQuery, AuctionHouseQuery, AuctionQuery, AuditQuery, BallotQuery, BankQuery, BillingQuery, BinQuery, BlogQuery, BookQuery, BrokerQuery, BusinessQuery, BusinessQuery, CalendarQuery, CampusQuery, CatalogQuery, CatalogueQuery, ChecklistQuery, CompositionQuery, ConfigurationQuery, ConvocationQuery, CookbookQuery, CourseCatalogQuery, DepotQuery, DictionaryQuery, DirectoryQuery, DispatchQuery, DistributorQuery, EngineQuery, EngineQuery, EntryQuery, FamilyQuery, ForumQuery, FoundryQuery, FrontOfficeQuery, GradebookQuery, GraphQuery, HierarchyQuery, InquestQuery, IssueQuery, JobQuery, JournalQuery, LogQuery, MailboxQuery, MapQuery, ObjectiveBankQuery, OfficeQuery, OntologyQuery, OsidCatalogQuery, OsidGovernatorQuery, OublietteQuery, PackageQuery, PollsQuery, PoolQuery, PressQuery, ProcessQuery, ProcessQuery, ProfileQuery, PublisherQuery, QueueQuery, QueueQuery, RaceQuery, RealmQuery, RecipeQuery, RepositoryQuery, StoreQuery, SystemQuery, UtilityQuery, VaultQuery, WarehouseQuery
public interface OsidSourceableQuery extends OsidQuery

The OsidSourceableQuery is used to assemble search queries for sourceables.

  • Method Details

    • matchProviderId

      void matchProviderId(Id resourceId, boolean match)
      Match the Id of the provider resource.
      Parameters:
      resourceId - Id to match
      match - true if for a positive match, false for a negative match
      Throws:
      NullArgumentException - resourceId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearProviderIdTerms

      void clearProviderIdTerms()
      Clears all provider Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsProviderQuery

      boolean supportsProviderQuery()
      Tests if a ResourceQuery for the provider is available.
      Returns:
      true if a resource query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getProviderQuery

      ResourceQuery getProviderQuery(boolean match)
      Gets the query for the provider. Each retrieval performs a boolean OR .
      Parameters:
      match - true if for a positive match, false for a negative match
      Returns:
      the provider query
      Throws:
      UnimplementedException - supportsProviderQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProviderQuery()} is {@code true} .

    • matchAnyProvider

      void matchAnyProvider(boolean match)
      Match sourceables with a provider value.
      Parameters:
      match - true to match sourceables with any provider, false to match sourceables with no providers
      Compliance:
      mandatory - This method must be implemented.

    • clearProviderTerms

      void clearProviderTerms()
      Clears all provider terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchBrandingId

      void matchBrandingId(Id assetId, boolean match)
      Match the Id of an asset used for branding.
      Parameters:
      assetId - Id to match
      match - true if for a positive match, false for a negative match
      Throws:
      NullArgumentException - assetId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearBrandingIdTerms

      void clearBrandingIdTerms()
      Clears all asset Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsBrandingQuery

      boolean supportsBrandingQuery()
      Tests if an AssetQuery for the branding is available.
      Returns:
      true if an asset query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getBrandingQuery

      AssetQuery getBrandingQuery(boolean match)
      Gets the query for an asset. Each retrieval performs a boolean OR .
      Parameters:
      match - true if for a positive match, false for a negative match
      Returns:
      the asset query
      Throws:
      UnimplementedException - supportsBrandingQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsBrandingQuery()} is {@code true} .

    • matchAnyBranding

      void matchAnyBranding(boolean match)
      Match sourceables with any branding.
      Parameters:
      match - true to match any asset, false to match no assets
      Compliance:
      mandatory - This method must be implemented.

    • clearBrandingTerms

      void clearBrandingTerms()
      Clears all branding terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchLicense

      void matchLicense(String license, Type stringMatchType, boolean match)
      Adds a license to match. Multiple license matches can be added to perform a boolean OR among them.
      Parameters:
      license - a string to match
      stringMatchType - the string match type
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - license is not of stringMatchType
      NullArgumentException - license or stringMatchType is null
      UnsupportedException - supportsStringMatchType(stringMatchType) is false
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyLicense

      void matchAnyLicense(boolean match)
      Matches any object with a license.
      Parameters:
      match - true to match any license, false to match objects with no license
      Compliance:
      mandatory - This method must be implemented.

    • clearLicenseTerms

      void clearLicenseTerms()
      Clears all license terms.
      Compliance:
      mandatory - This method must be implemented.