001/*
002 *  Copyright 2014 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016
017package org.ametys.cms.content.references;
018
019import org.ametys.cms.data.RichText;
020
021/**
022 * Extracts the outgoing references from a rich text metadata.
023 * This <b>may be</b> part of the (global) outgoing references extractor.
024 */
025public interface RichTextOutgoingReferencesExtractor
026{
027    /**
028     * This method analyzes a rich text to return the list of outgoing references
029     * @param richText The rich text to analyze
030     * @return The outgoing references for the rich text
031     */
032    public OutgoingReferences getOutgoingReferences(RichText richText);
033}