Module org.opengis.geoapi

Package org.opengis.metadata.distribution

Interface StandardOrderProcess

@UML(identifier="MD_StandardOrderProcess",
     specification=ISO_19115)
public interface StandardOrderProcess

Common ways in which the resource may be obtained or received, and related instructions and fee information.

Since:

2.0

Method Summary

Modifier and Type	Method	Description
default Currency	getCurrency()	The monetary units of the fees (as specified in ISO 4217).
default InternationalString	getFees()	Fees and terms for retrieving the resource.
default InternationalString	getOrderingInstructions()	General instructions, terms and services provided by the distributor.
default Record	getOrderOptions()	Request/purchase choices.
default RecordType	getOrderOptionsType()	Description of the order options record.
default Temporal	getPlannedAvailableDate()	Date and time when the dataset will be available.
default Date	getPlannedAvailableDateTime()	Deprecated. Replaced by getPlannedAvailableDate().
default InternationalString	getTurnaround()	Typical turnaround time for the filling of an order.

Method Details

getFees

@UML(identifier="fees",
     obligation=OPTIONAL,
     specification=ISO_19115)
default InternationalString getFees()

Fees and terms for retrieving the resource. Includes monetary units (as specified in ISO 4217). The monetary units may also be available with getCurrency().

Returns:

fees and terms for retrieving the resource, or null.

getCurrency

default Currency getCurrency()

The monetary units of the fees (as specified in ISO 4217).

Constraints:
For ISO 19115 compatibility reasons, this method is not required to return a non-null value even if the text returned by getFees() contains a currency units. However, if this method returns a non-null value, then that value is required to be consistent with the fees text.

Returns:

the fees monetary units, or null if none or unknown.

Since:

3.1

Departure from OGC/ISO standard for closer integration with the Java environment

This method is not part of ISO specification. It has been added in GeoAPI for integration with the standard JDK library.

getPlannedAvailableDateTime

@Deprecated(since="3.1")
default Date getPlannedAvailableDateTime()

Deprecated.

Replaced by getPlannedAvailableDate().

Date and time when the dataset will be available.

Returns:

date and time when the dataset will be available, or null.

getPlannedAvailableDate

@UML(identifier="plannedAvailableDateTime",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Temporal getPlannedAvailableDate()

Date and time when the dataset will be available. The returned value should be an instance of LocalDate, LocalDateTime, OffsetDateTime or ZonedDateTime, depending whether hours are defined and how the timezone (if any) is defined. But other types are also allowed.

Returns:

date and time when the dataset will be available, or null.

Since:

3.1

getOrderingInstructions

@UML(identifier="orderingInstructions",
     obligation=OPTIONAL,
     specification=ISO_19115)
default InternationalString getOrderingInstructions()

General instructions, terms and services provided by the distributor.

Returns:

general instructions, terms and services provided by the distributor, or null.

getTurnaround

@UML(identifier="turnaround",
     obligation=OPTIONAL,
     specification=ISO_19115)
default InternationalString getTurnaround()

Typical turnaround time for the filling of an order.

Returns:

typical turnaround time for the filling of an order, or null.

getOrderOptionsType

@UML(identifier="orderOptionsType",
     obligation=OPTIONAL,
     specification=ISO_19115)
default RecordType getOrderOptionsType()

Description of the order options record.

Returns:

description of the order options record, or null if none.

Since:

3.1

See Also:

• Record.getRecordType()

getOrderOptions

@UML(identifier="orderOptions",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Record getOrderOptions()

Request/purchase choices.

Returns:

request/purchase choices.

Since:

3.1

TODO:

We presume that this record is filled by the vendor for describing the options chosen by the client when he ordered the resource. We presume that this is not a record to be filled by the user for new orders, otherwise this method would need to be a factory rather than a getter.