/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.guacamole.language;

/**
 * An interface which requires the definition of a translatable message that
 * can be passed through an arbitrary translation service, producing a
 * human-readable message in the user's native language.
 *
 * @author Michael Jumper
 */
public interface Translatable {

    /**
     * Returns a message which can be translated using a translation service,
     * consisting of a translation key and optional set of substitution
     * variables.
     *
     * @return
     *     A message which can be translated using a translation service.
     */
    TranslatableMessage getTranslatableMessage();

}

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.guacamole.language;

/**
 * An object which is associated with a translatable message that can be passed
 * through an arbitrary translation service, producing a human-readable message
 * in the user's native language.
 *
 * @author Michael Jumper
 */
public interface Translatable {

    /**
     * Returns a message which can be translated using a translation service,
     * consisting of a translation key and optional set of substitution
     * variables.
     *
     * @return
     *     A message which can be translated using a translation service.
     */
    TranslatableMessage getTranslatableMessage();

}

Clarify description/use of Translatable interface.