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

Class DefaultStandardOrderProcess

Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
DefaultStandardOrderProcess
All Implemented Interfaces:
Serializable, Emptiable, Lenient­Comparable, Identified­Object, Standard­Order­Process
public class DefaultStandardOrderProcess extends ISOMetadata implements 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
See Also:

  • Constructor Details

    • DefaultStandardOrderProcess

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

    • DefaultStandardOrderProcess

      public DefaultStandardOrderProcess(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(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 Default­Standard­Order­Process, then it is returned unchanged.
      • Otherwise a new Default­Standard­Order­Process 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 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 get­Currency().
      Specified by:
      get­Fees in interface Standard­Order­Process
      Returns:
      fees and terms for retrieving the resource, or null.
      See Also:

    • setFees

      public void setFees(InternationalString newValue)
      Sets fees and terms for retrieving the resource. Include monetary units (as specified in ISO 4217).
      Parameters:
      new­Value - 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 get­Fees() 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:
      new­Value - 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:
      get­Planned­Available­Date­Time in interface Standard­Order­Process
      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:
      new­Value - the new planned available time.

    • getOrderingInstructions

      public InternationalString getOrderingInstructions()
      Returns general instructions, terms and services provided by the distributor.
      Specified by:
      get­Ordering­Instructions in interface Standard­Order­Process
      Returns:
      general instructions, terms and services provided by the distributor, or null.

    • setOrderingInstructions

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

    • getTurnaround

      public InternationalString getTurnaround()
      Returns typical turnaround time for the filling of an order.
      Specified by:
      get­Turnaround in interface Standard­Order­Process
      Returns:
      typical turnaround time for the filling of an order, or null.

    • setTurnaround

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

    • getOrderOptionsType

      @UML(identifier="orderOptionsType", obligation=OPTIONAL, specification=ISO_19115) public 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:

    • setOrderOptionsType

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

    • getOrderOptions

      @UML(identifier="orderOptions", obligation=OPTIONAL, specification=ISO_19115) public Record getOrderOptions()
      Returns the request/purchase choices.
      Returns:
      request/purchase choices.
      Since:
      0.5
      "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.

    • setOrderOptions

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