001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2004-2012 Open Geospatial Consortium, Inc.
006 * All Rights Reserved. http://www.opengeospatial.org/ogc/legal
007 *
008 * Permission to use, copy, and modify this software and its documentation, with
009 * or without modification, for any purpose and without fee or royalty is hereby
010 * granted, provided that you include the following on ALL copies of the software
011 * and documentation or portions thereof, including modifications, that you make:
012 *
013 * 1. The full text of this NOTICE in a location viewable to users of the
014 * redistributed or derivative work.
015 * 2. Notice of any changes or modifications to the OGC files, including the
016 * date changes were made.
017 *
018 * THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
019 * NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
020 * TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
021 * THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
022 * PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
023 *
024 * COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
025 * CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
026 *
027 * The name and trademarks of copyright holders may NOT be used in advertising or
028 * publicity pertaining to the software without specific, written prior permission.
029 * Title to copyright in this software and any associated documentation will at all
030 * times remain with copyright holders.
031 */
032 package org.opengis.metadata.citation;
033
034 import java.net.URI;
035 import org.opengis.util.InternationalString;
036 import org.opengis.annotation.UML;
037 import org.opengis.annotation.Profile;
038
039 import static org.opengis.annotation.Obligation.*;
040 import static org.opengis.annotation.ComplianceLevel.*;
041 import static org.opengis.annotation.Specification.*;
042
043
044 /**
045 * Information about on-line sources from which the dataset, specification, or
046 * community profile name and extended metadata elements can be obtained.
047 *
048 * @author Martin Desruisseaux (IRD)
049 * @author Cory Horner (Refractions Research)
050 * @version 3.0
051 * @since 1.0
052 *
053 * @navassoc 1 - - OnLineFunction
054 */
055 @UML(identifier="CI_OnlineResource", specification=ISO_19115)
056 public interface OnlineResource {
057 /**
058 * Location (address) for on-line access using a Uniform Resource Locator address or
059 * similar addressing scheme such as {@code "http://www.statkart.no/isotc211"}.
060 *
061 * @return Location for on-line access using a Uniform Resource Locator address or similar scheme.
062 */
063 @Profile(level=CORE)
064 @UML(identifier="linkage", obligation=MANDATORY, specification=ISO_19115)
065 URI getLinkage();
066
067 /**
068 * Connection protocol to be used. Returns {@code null} if none.
069 *
070 * @return Connection protocol to be used, or {@code null}.
071 */
072 @UML(identifier="protocol", obligation=OPTIONAL, specification=ISO_19115)
073 String getProtocol();
074
075 /**
076 * Name of an application profile that can be used with the online resource.
077 * Returns {@code null} if none.
078 *
079 * @return Application profile that can be used with the online resource, or {@code null}.
080 */
081 @UML(identifier="applicationProfile", obligation=OPTIONAL, specification=ISO_19115)
082 String getApplicationProfile();
083
084 /**
085 * Name of the online resource. Returns {@code null} if none.
086 *
087 * @return Name of the online resource, or {@code null}.
088 *
089 * @since 2.1
090 */
091 @UML(identifier="name", obligation=OPTIONAL, specification=ISO_19115)
092 String getName();
093
094 /**
095 * Detailed text description of what the online resource is/does.
096 * Returns {@code null} if none.
097 *
098 * @return Text description of what the online resource is/does, or {@code null}.
099 */
100 @UML(identifier="description", obligation=OPTIONAL, specification=ISO_19115)
101 InternationalString getDescription();
102
103 /**
104 * Code for function performed by the online resource.
105 * Returns {@code null} if unspecified.
106 *
107 * @return Function performed by the online resource, or {@code null}.
108 */
109 @UML(identifier="function", obligation=OPTIONAL, specification=ISO_19115)
110 OnLineFunction getFunction();
111 }