| Class | Line # | Actions | |||||
|---|---|---|---|---|---|---|---|
| LinkService | 33 | 0 | - | 0 | 0 |
| 1 | /* | |
| 2 | * See the NOTICE file distributed with this work for additional | |
| 3 | * information regarding copyright ownership. | |
| 4 | * | |
| 5 | * This is free software; you can redistribute it and/or modify it | |
| 6 | * under the terms of the GNU Lesser General Public License as | |
| 7 | * published by the Free Software Foundation; either version 2.1 of | |
| 8 | * the License, or (at your option) any later version. | |
| 9 | * | |
| 10 | * This software is distributed in the hope that it will be useful, | |
| 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 | * Lesser General Public License for more details. | |
| 14 | * | |
| 15 | * You should have received a copy of the GNU Lesser General Public | |
| 16 | * License along with this software; if not, write to the Free | |
| 17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
| 18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
| 19 | */ | |
| 20 | package org.xwiki.wysiwyg.server.wiki; | |
| 21 | ||
| 22 | import org.xwiki.component.annotation.Role; | |
| 23 | import org.xwiki.gwt.wysiwyg.client.wiki.EntityConfig; | |
| 24 | import org.xwiki.gwt.wysiwyg.client.wiki.EntityReference; | |
| 25 | import org.xwiki.gwt.wysiwyg.client.wiki.ResourceReference; | |
| 26 | ||
| 27 | /** | |
| 28 | * The service used to create links. | |
| 29 | * | |
| 30 | * @version $Id: 34b586ba4f7cf9a38b65dc947b53fd244011863a $ | |
| 31 | */ | |
| 32 | @Role | |
| 33 | public interface LinkService | |
| 34 | { | |
| 35 | /** | |
| 36 | * Creates an entity link configuration object (URL, link reference) for a link with the specified origin and | |
| 37 | * destination. The link reference in the returned {@link EntityConfig} is relative to the link origin. | |
| 38 | * | |
| 39 | * @param origin the origin of the link | |
| 40 | * @param destination the destination of the link | |
| 41 | * @return the link configuration object that can be used to insert the link in the origin page | |
| 42 | */ | |
| 43 | EntityConfig getEntityConfig(EntityReference origin, ResourceReference destination); | |
| 44 | ||
| 45 | /** | |
| 46 | * Parses the given link reference and extracts a reference to the linked resource. The returned resource reference | |
| 47 | * is resolved relative to the given base entity reference. | |
| 48 | * | |
| 49 | * @param linkReference a serialized link reference | |
| 50 | * @param baseReference the entity reference used to resolve the linked resource reference | |
| 51 | * @return a reference to the linked resource | |
| 52 | */ | |
| 53 | ResourceReference parseLinkReference(String linkReference, EntityReference baseReference); | |
| 54 | } |