Module org.opengis.geoapi

Package org.opengis.metadata.acquisition

Interface Requirement

@UML(identifier="MI_Requirement",
     specification=ISO_19115_2)
public interface Requirement

Requirement to be satisfied by the planned data acquisition.

Since:

2.3

Method Summary

Modifier and Type	Method	Description
default Citation	getCitation()	Identification of reference or guidance material for the requirement.
Date	getExpiryDate()	Date and time after which collection is no longer valid.
Identifier	getIdentifier()	Unique name, or code, for the requirement.
Priority	getPriority()	Relative ordered importance, or urgency, of the requirement.
Collection<? extends ResponsibleParty>	getRecipients()	Person(s), or body(ies), to receive results of requirement.
RequestedDate	getRequestedDate()	Required or preferred acquisition date and time.
Collection<? extends ResponsibleParty>	getRequestors()	Origin of requirement.
default Collection<? extends Plan>	getSatisfiedPlans()	Plan that identifies solution to satisfy the requirement.

Method Details

getCitation

@UML(identifier="citation",
     obligation=OPTIONAL,
     specification=ISO_19115_2)
default Citation getCitation()

Identification of reference or guidance material for the requirement.

Returns:

identification of reference or guidance material, or null.

getIdentifier

@UML(identifier="identifier",
     obligation=MANDATORY,
     specification=ISO_19115_2)
Identifier getIdentifier()

Unique name, or code, for the requirement.

Returns:

unique name or code.

getRequestors

@UML(identifier="requestor",
     obligation=MANDATORY,
     specification=ISO_19115_2,
     version=2003)
Collection<? extends ResponsibleParty> getRequestors()

Origin of requirement.

Upcoming API change — generalization
As of ISO 19115:2014, ResponsibleParty is replaced by the

invalid reference

Responsibility

parent interface. This change may be applied in GeoAPI 4.0.

Returns:

origin of requirement.

getRecipients

@UML(identifier="recipient",
     obligation=MANDATORY,
     specification=ISO_19115_2,
     version=2003)
Collection<? extends ResponsibleParty> getRecipients()

Person(s), or body(ies), to receive results of requirement.

Upcoming API change — generalization
As of ISO 19115:2014, ResponsibleParty is replaced by the

invalid reference

Responsibility

parent interface. This change may be applied in GeoAPI 4.0.

Returns:

person(s), or body(ies), to receive results.

getPriority

@UML(identifier="priority",
     obligation=MANDATORY,
     specification=ISO_19115_2)
Priority getPriority()

Relative ordered importance, or urgency, of the requirement.

Returns:

relative ordered importance, or urgency.

getRequestedDate

@UML(identifier="requestedDate",
     obligation=MANDATORY,
     specification=ISO_19115_2)
RequestedDate getRequestedDate()

Required or preferred acquisition date and time.

Returns:

required or preferred acquisition date and time.

getExpiryDate

@UML(identifier="expiryDate",
     obligation=MANDATORY,
     specification=ISO_19115_2)
Date getExpiryDate()

Date and time after which collection is no longer valid.

Upcoming API change — temporal schema
As of Java 8, the java.time package is a better match for the different types of date defined by ISO 19108 (Temporal Schema) or ISO 19103. The return value of this method may be changed to Temporal in GeoAPI 4.0.

Returns:

date and time after which collection is no longer valid.

getSatisfiedPlans

@UML(identifier="satisfiedPlan",
     obligation=OPTIONAL,
     specification=ISO_19115_2)
default Collection<? extends Plan> getSatisfiedPlans()

Plan that identifies solution to satisfy the requirement.

Returns:

plan that identifies solution to satisfy the requirement.