Module org.opengis.geoapi

Package org.opengis.metadata.identification

Interface ServiceIdentification

All Superinterfaces:

Identification

@UML(identifier="SV_ServiceIdentification",
     specification=ISO_19115)
public interface ServiceIdentification
extends Identification

Identification of capabilities which a service provider makes available. The services are provided to a user through a set of interfaces that define a behaviour.

Since:

2.0

Method Summary

Modifier and Type	Method	Description
default StandardOrderProcess	getAccessProperties()	Information about the availability of the service.
default Collection<? extends OperationChainMetadata>	getContainsChain()	Provides information about the chain applied by the service.
default Collection<? extends OperationMetadata>	getContainsOperations()	Provides information about the operations that comprise the service.
Collection<? extends CoupledResource>	getCoupledResources()	Further description(s) of the data coupling in the case of tightly coupled services.
CouplingType	getCouplingType()	Type of coupling between service and associated data (if exist).
default Collection<? extends Citation>	getOperatedDatasets()	Provides reference(s) to the resources on which the service operates.
default Collection<? extends DataIdentification>	getOperatesOn()	Provides information on the resources that the service operates on.
default Collection<? extends Citation>	getProfiles()	Profile(s) to which the service adheres.
default Collection<? extends Citation>	getServiceStandards()	Standard(s) to which the service adheres.
GenericName	getServiceType()	A service type name.
default Collection<String>	getServiceTypeVersions()	The version(s) of the service.

Methods inherited from interface Identification

getAbstract, getAdditionalDocumentations, getAggregationInfo, getAssociatedResources, getCitation, getCredits, getDescriptiveKeywords, getExtents, getGraphicOverviews, getPointOfContacts, getProcessingLevel, getPurpose, getResourceConstraints, getResourceFormats, getResourceMaintenances, getResourceSpecificUsages, getSpatialRepresentationTypes, getSpatialResolutions, getStatus, getTemporalResolutions, getTopicCategories

Method Details

getServiceType

@UML(identifier="serviceType",
     obligation=MANDATORY,
     specification=ISO_19115)
GenericName getServiceType()

A service type name.

Examples: "discovery", "view", "download", "transformation", or "invoke".

Returns:

a service type name.

Since:

3.1

getServiceTypeVersions

@UML(identifier="serviceTypeVersion",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Collection<String> getServiceTypeVersions()

The version(s) of the service. Supports searching based on the version of service type.

Example: we might only be interested in OGC Catalogue V1.1 services. If version is maintained as a separate attribute, users can easily search for all services of a type regardless of the version.

Returns:

the version of the service, supports searching based on the version of serviceType.

Since:

3.1

getAccessProperties

@UML(identifier="accessProperties",
     obligation=OPTIONAL,
     specification=ISO_19115)
default StandardOrderProcess getAccessProperties()

Information about the availability of the service. This includes:

• fee
• planned available date and time
• ordering instructions
• turnaround

Returns:

information about the availability of the service, or null if none.

Since:

3.1

getCouplingType

@UML(identifier="couplingType",
     obligation=CONDITIONAL,
     specification=ISO_19115)
CouplingType getCouplingType()

Type of coupling between service and associated data (if exist).

Returns:

type of coupling between service and associated data, or null if none.

Since:

3.1

Condition:

mandatory if coupledResources is not provided.

getCoupledResources

@UML(identifier="coupledResource",
     obligation=CONDITIONAL,
     specification=ISO_19115)
Collection<? extends CoupledResource> getCoupledResources()

Further description(s) of the data coupling in the case of tightly coupled services. Returns an empty collection if none.

Returns:

further description of the data coupling in the case of tightly coupled services.

Since:

3.1

Condition:

mandatory if couplingType is not provided.

getOperatedDatasets

@UML(identifier="operatedDataset",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Collection<? extends Citation> getOperatedDatasets()

Provides reference(s) to the resources on which the service operates. Returns an empty collection if none.

Returns:

reference(s) to the resource on which the service operates.

Since:

3.1

Condition:

For one resource either operatedDataset or operatesOn may be used (not both for the same resource).

getProfiles

@UML(identifier="profile",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Collection<? extends Citation> getProfiles()

Profile(s) to which the service adheres. Returns an empty collection if none.

Returns:

profile(s) to which the service adheres.

Since:

3.1

getServiceStandards

@UML(identifier="serviceStandard",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Collection<? extends Citation> getServiceStandards()

Standard(s) to which the service adheres. Returns an empty collection if none.

Returns:

standard(s) to which the service adheres.

Since:

3.1

getContainsOperations

@UML(identifier="containsOperations",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Collection<? extends OperationMetadata> getContainsOperations()

Provides information about the operations that comprise the service. Returns an empty collection if none.

Returns:

information about the operations that comprise the service.

Since:

3.1

getOperatesOn

@UML(identifier="operatesOn",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Collection<? extends DataIdentification> getOperatesOn()

Provides information on the resources that the service operates on. Returns an empty collection if none.

Returns:

information on the resources that the service operates on.

Since:

3.1

Condition:

For one resource either operatedDataset or operatesOn may be used (not both for the same resource).

getContainsChain

@UML(identifier="containsChain",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Collection<? extends OperationChainMetadata> getContainsChain()

Provides information about the chain applied by the service. Returns an empty collection if none.

Returns:

information about the chain applied by the service.

Since:

3.1