Interface EndpointQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector
public interface EndpointQueryInspector extends OsidCatalogQueryInspector

This is the query inspector for examining endpoint queries.

  • Method Details

    • getResourceIdTerms

      IdTerm[] getResourceIdTerms()
      Gets the resource Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getResourceTerms

      ResourceQueryInspector[] getResourceTerms()
      Gets the resource query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorEndpointIdTerms

      IdTerm[] getAncestorEndpointIdTerms()
      Gets the ancestor endpoint Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorEndpointTerms

      EndpointQueryInspector[] getAncestorEndpointTerms()
      Gets the ancestor endpoint query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantEndpointIdTerms

      IdTerm[] getDescendantEndpointIdTerms()
      Gets the descendant endpoint Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantEndpointTerms

      EndpointQueryInspector[] getDescendantEndpointTerms()
      Gets the descendant endpoint query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getEndpointQueryInspectorRecord

      EndpointQueryInspectorRecord getEndpointQueryInspectorRecord(Type endpointRecordType) throws OperationFailedException
      Gets the endpoint query inspector record corresponding to the given Endpoint record Type.
      Parameters:
      endpointRecordType - a endpoint record type
      Returns:
      the endpoint query inspector record
      Throws:
      NullArgumentException - endpointRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(endpointRecordType) is false
      Compliance:
      mandatory - This method must be implemented.