Package org.apache.sis.metadata.iso.distribution

Class DefaultStandardOrderProcess

java.lang.Object
org.apache.sis.metadata.AbstractMetadata
org.apache.sis.metadata.ModifiableMetadata
org.apache.sis.metadata.iso.ISOMetadata
org.apache.sis.metadata.iso.distribution.DefaultStandardOrderProcess
All Implemented Interfaces:
Serializable, Emptiable, LenientComparable, IdentifiedObject, org.opengis.metadata.distribution.StandardOrderProcess
public class DefaultStandardOrderProcess extends ISOMetadata implements org.opengis.metadata.distribution.StandardOrderProcess
Common ways in which the resource may be obtained or received, and related instructions and fee information.

Limitations

  • Instances of this class are not synchronized for multi-threading. Synchronization, if needed, is caller's responsibility.
  • Serialized objects of this class are not guaranteed to be compatible with future Apache SIS releases. Serialization support is appropriate for short term storage or RMI between applications running the same version of Apache SIS. For long term storage, use XML instead.
Since:
0.3
Version:
1.0
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      Serial number for inter-operability with different versions.
      See Also:

    • fees

      private org.opengis.util.InternationalString fees
      Fees and terms for retrieving the resource. Include monetary units (as specified in ISO 4217).

    • currency

      private Currency currency
      The fees currency, or null if unknown or unspecified.

    • plannedAvailableDateTime

      private long plannedAvailableDateTime
      Date and time when the dataset will be available, in milliseconds elapsed since January 1st, 1970.

    • orderingInstructions

      private org.opengis.util.InternationalString orderingInstructions
      General instructions, terms and services provided by the distributor.

    • turnaround

      private org.opengis.util.InternationalString turnaround
      Typical turnaround time for the filling of an order.

    • orderOptionsType

      private org.opengis.util.RecordType orderOptionsType
      Description of the order options record.

    • orderOptions

      private org.opengis.util.Record orderOptions
      Request/purchase choices.

  • Constructor Details

    • DefaultStandardOrderProcess

      public DefaultStandardOrderProcess()
      Constructs an initially empty standard order process.

    • DefaultStandardOrderProcess

      public DefaultStandardOrderProcess(org.opengis.metadata.distribution.StandardOrderProcess object)
      Constructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, because the other metadata contained in the given object are not recursively copied.
      Parameters:
      object - the metadata to copy values from, or null if none.
      See Also:

  • Method Details

    • castOrCopy

      public static DefaultStandardOrderProcess castOrCopy(org.opengis.metadata.distribution.StandardOrderProcess object)
      Returns a SIS metadata implementation with the values of the given arbitrary implementation. This method performs the first applicable action in the following choices:
      • If the given object is null, then this method returns null.
      • Otherwise if the given object is already an instance of DefaultStandardOrderProcess, then it is returned unchanged.
      • Otherwise a new DefaultStandardOrderProcess instance is created using the copy constructor and returned. Note that this is a shallow copy operation, because the other metadata contained in the given object are not recursively copied.
      Parameters:
      object - the object to get as a SIS implementation, or null if none.
      Returns:
      a SIS implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

    • getFees

      public org.opengis.util.InternationalString getFees()
      Returns fees and terms for retrieving the resource. Include monetary units (as specified in ISO 4217). The monetary units may also be available with getCurrency().
      Specified by:
      getFees in interface org.opengis.metadata.distribution.StandardOrderProcess
      Returns:
      fees and terms for retrieving the resource, or null.
      See Also:

    • setFees

      public void setFees(org.opengis.util.InternationalString newValue)
      Sets fees and terms for retrieving the resource. Include monetary units (as specified in ISO 4217).
      Parameters:
      newValue - the new fees.
      See Also:

    • getCurrency

      public Currency getCurrency()
      Returns 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:
      0.5
      See Also:

    • setCurrency

      public void setCurrency(Currency newValue)
      Sets the monetary units of the fees (as specified in ISO 4217). Callers should ensure that the given currency is consistent with the currency in the fees text.
      Parameters:
      newValue - the new currency.
      Since:
      0.5
      See Also:

    • getPlannedAvailableDateTime

      public Date getPlannedAvailableDateTime()
      Returns the date and time when the dataset will be available.
      Specified by:
      getPlannedAvailableDateTime in interface org.opengis.metadata.distribution.StandardOrderProcess
      Returns:
      date and time when the dataset will be available, or null.

    • setPlannedAvailableDateTime

      public void setPlannedAvailableDateTime(Date newValue)
      Sets the date and time when the dataset will be available.
      Parameters:
      newValue - the new planned available time.

    • getOrderingInstructions

      public org.opengis.util.InternationalString getOrderingInstructions()
      Returns general instructions, terms and services provided by the distributor.
      Specified by:
      getOrderingInstructions in interface org.opengis.metadata.distribution.StandardOrderProcess
      Returns:
      general instructions, terms and services provided by the distributor, or null.

    • setOrderingInstructions

      public void setOrderingInstructions(org.opengis.util.InternationalString newValue)
      Sets general instructions, terms and services provided by the distributor.
      Parameters:
      newValue - the new ordering instructions.

    • getTurnaround

      public org.opengis.util.InternationalString getTurnaround()
      Returns typical turnaround time for the filling of an order.
      Specified by:
      getTurnaround in interface org.opengis.metadata.distribution.StandardOrderProcess
      Returns:
      typical turnaround time for the filling of an order, or null.

    • setTurnaround

      public void setTurnaround(org.opengis.util.InternationalString newValue)
      Sets typical turnaround time for the filling of an order.
      Parameters:
      newValue - the new turnaround.

    • getOrderOptionsType

      @UML(identifier="orderOptionsType", obligation=OPTIONAL, specification=ISO_19115) public org.opengis.util.RecordType getOrderOptionsType()
      Returns the description of the order options record.
      Returns:
      description of the order options record, or null if none.
      Since:
      1.0
      See Also:

    • getOrderOptionType

      public org.opengis.util.RecordType getOrderOptionType()
      Deprecated.
      Renamed getOrderOptionsType() for ISO 19115 conformance.
      Returns:
      description of the order options record, or null if none.
      Since:
      0.5

    • setOrderOptionsType

      public void setOrderOptionsType(org.opengis.util.RecordType newValue)
      Sets the description of the order options record.
      Parameters:
      newValue - new description of the order options record.
      Since:
      1.0

    • setOrderOptionType

      @Deprecated public void setOrderOptionType(org.opengis.util.RecordType newValue)
      Deprecated.
      Renamed setOrderOptionsType(RecordType) for ISO 19115 conformance.
      Parameters:
      newValue - new description of the order options record.
      Since:
      0.5

    • getOrderOptions

      @UML(identifier="orderOptions", obligation=OPTIONAL, specification=ISO_19115) public org.opengis.util.Record getOrderOptions()
      Returns the request/purchase choices.
      Returns:
      request/purchase choices.
      Since:
      0.5

    • setOrderOptions

      public void setOrderOptions(org.opengis.util.Record newValue)
      Sets the request/purchase choices.
      Parameters:
      newValue - the new request/purchase choices.
      Since:
      0.5