Module org.apache.sis.metadata
Class DefaultStandardOrderProcess
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
DefaultStandardOrderProcess
- All Implemented Interfaces:
Serializable,Emptiable,LenientComparable,IdentifiedObject,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
XMLinstead.
- Since:
- 0.3
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class ModifiableMetadata
ModifiableMetadata.State -
Field Summary
Fields inherited from class ISOMetadata
identifiers -
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty standard order process.Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptioncastOrCopy(StandardOrderProcess object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Returns the monetary units of thefees(as specified in ISO 4217).getFees()Returns fees and terms for retrieving the resource.Returns general instructions, terms and services provided by the distributor.Returns the request/purchase choices.Returns the description of the order options record.Returns the date and time when the dataset will be available.Returns typical turnaround time for the filling of an order.voidsetCurrency(Currency newValue) Sets the monetary units of thefees(as specified in ISO 4217).voidsetFees(InternationalString newValue) Sets fees and terms for retrieving the resource.voidsetOrderingInstructions(InternationalString newValue) Sets general instructions, terms and services provided by the distributor.voidsetOrderOptions(Record newValue) Sets the request/purchase choices.voidsetOrderOptionsType(RecordType newValue) Sets the description of the order options record.voidsetPlannedAvailableDateTime(Date newValue) Sets the date and time when the dataset will be available.voidsetTurnaround(InternationalString newValue) Sets typical turnaround time for the filling of an order.Methods inherited from class ISOMetadata
getIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionToMethods inherited from class ModifiableMetadata
checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
-
Constructor Details
-
DefaultStandardOrderProcess
public DefaultStandardOrderProcess()Constructs an initially empty standard order process. -
DefaultStandardOrderProcess
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, ornullif none.- See Also:
-
-
Method Details
-
castOrCopy
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 returnsnull. - Otherwise if the given object is already an instance of
DefaultStandardOrderProcess, then it is returned unchanged. - Otherwise a new
DefaultStandardOrderProcessinstance 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, ornullif none.- Returns:
- a SIS implementation containing the values of the given object (may be the
given object itself), or
nullif the argument was null.
- If the given object is
-
getFees
Returns fees and terms for retrieving the resource. Include monetary units (as specified in ISO 4217). The monetary units may also be available withgetCurrency().- Specified by:
getFeesin interfaceStandardOrderProcess- Returns:
- fees and terms for retrieving the resource, or
null. - See Also:
-
setFees
Sets fees and terms for retrieving the resource. Include monetary units (as specified in ISO 4217).- Parameters:
newValue- the new fees.- See Also:
-
getCurrency
Returns the monetary units of thefees(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 bygetFees()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
nullif none or unknown. - Since:
- 0.5
- See Also:
-
setCurrency
Sets the monetary units of thefees(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
Returns the date and time when the dataset will be available.- Specified by:
getPlannedAvailableDateTimein interfaceStandardOrderProcess- Returns:
- date and time when the dataset will be available, or
null.
-
setPlannedAvailableDateTime
Sets the date and time when the dataset will be available.- Parameters:
newValue- the new planned available time.
-
getOrderingInstructions
Returns general instructions, terms and services provided by the distributor.- Specified by:
getOrderingInstructionsin interfaceStandardOrderProcess- Returns:
- general instructions, terms and services provided by the distributor, or
null.
-
setOrderingInstructions
Sets general instructions, terms and services provided by the distributor.- Parameters:
newValue- the new ordering instructions.
-
getTurnaround
Returns typical turnaround time for the filling of an order.- Specified by:
getTurnaroundin interfaceStandardOrderProcess- Returns:
- typical turnaround time for the filling of an order, or
null.
-
setTurnaround
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 RecordType getOrderOptionsType()Returns the description of the order options record.- Returns:
- description of the order options record, or
nullif none. - Since:
- 1.0
- See Also:
-
setOrderOptionsType
Sets the description of the order options record.- Parameters:
newValue- 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
Sets the request/purchase choices.- Parameters:
newValue- the new request/purchase choices.- Since:
- 0.5
-