Interface ShipmentSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ShipmentSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	Description
ShipmentQueryInspector	getShipmentQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ShipmentList	getShipments()	Gets the shipment list resulting from a search.
ShipmentSearchResultsRecord	getShipmentSearchResultsRecord(Type shipmentSearchRecordType)	Gets the shipment search results record corresponding to the given shipment search record Type .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getShipments

ShipmentList getShipments()

Gets the shipment list resulting from a search.

Returns:

the shipment list

Throws:

IllegalStateException - the shipment list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getShipmentQueryInspector

ShipmentQueryInspector getShipmentQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getShipmentSearchResultsRecord

ShipmentSearchResultsRecord getShipmentSearchResultsRecord(Type shipmentSearchRecordType)
                                                    throws OperationFailedException

Gets the shipment search results record corresponding to the given shipment search record Type .This method is used to retrieve an object implementing the requested record.

Parameters:

shipmentSearchRecordType - a shipment search record type

Returns:

the shipment search results record

Throws:

NullArgumentException - shipmentSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(shipmentSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.