org.zanata.rest.service

Interface TranslatedDocResource

All Known Subinterfaces:

ITranslatedDocResource

public interface TranslatedDocResource

projectSlug: Project Identifier. iterationSlug: Project Iteration identifier.

Author:

Sean Flanigan sflaniga@redhat.com

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_PATH

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	deleteTranslations(String idNoSlash, LocaleId locale) Deletes a set of translations for a given locale.
javax.ws.rs.core.Response	getTranslations(String idNoSlash, LocaleId locale, Set<String> extensions, boolean createSkeletons, String eTag) Retrieves a set of translations for a given locale.
javax.ws.rs.core.Response	putTranslations(String idNoSlash, LocaleId locale, TranslationsResource messageBody, Set<String> extensions, String merge) Updates the translations for a document and a locale.

Field Detail

SERVICE_PATH

static final String SERVICE_PATH

See Also:

Constant Field Values

Method Detail

getTranslations

javax.ws.rs.core.Response getTranslations(String idNoSlash,
                                        LocaleId locale,
                                        Set<String> extensions,
                                        boolean createSkeletons,
                                        @HeaderParam(value="If-None-Match")
                                        String eTag)

Retrieves a set of translations for a given locale.

Parameters:

idNoSlash - The document identifier. Some document ids could have forward slashes ('/') in them which would cause conflicts with the browser's own url interpreter. For this reason, the supplied id must have all its '/' characters replaced with commas (',').

locale - The locale for which to get translations.

extensions - The translation extensions to retrieve (e.g. "comment"). This parameter allows multiple values.

skeletons - Indicates whether to generate untranslated entries or not.

eTag - An Entity tag identifier. Based on this identifier (if provided), the server will decide if it needs to send a response to the client or not (See return section).

Returns:

The following response status codes will be returned from this operation:
OK(200) - Successfully retrieved translations. The data will be contained in the response.
NOT FOUND(404) - If a project, project iteration or document could not be found with the given parameters. Also if no translations are found for the given document and locale.
INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.
NOT_MODIFIED(304) - If the provided ETag matches the server's stored ETag, it will reply with this code, indicating that the last received response is still valid and should be reused.

deleteTranslations

javax.ws.rs.core.Response deleteTranslations(String idNoSlash,
                                           LocaleId locale)

Deletes a set of translations for a given locale. Also deletes any extensions recorded for the translations in question. The system will keep history of the translations.

Parameters:

idNoSlash - The document identifier. Some document ids could have forward slashes ('/') in them which would cause conflicts with the browser's own url interpreter. For this reason, the supplied id must have all its '/' characters replaced with commas (',').

locale - The locale for which to get translations.

Returns:

The following response status codes will be returned from this operation:
OK(200) - Successfully deleted the translations.
NOT FOUND(404) - If a project, project iteration or document could not be found with the given parameters. UNAUTHORIZED(401) - If the user does not have the proper permissions to perform this operation.
INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.

putTranslations

javax.ws.rs.core.Response putTranslations(String idNoSlash,
                                        LocaleId locale,
                                        TranslationsResource messageBody,
                                        Set<String> extensions,
                                        String merge)

Updates the translations for a document and a locale.

Parameters:

idNoSlash - The document identifier. Some document ids could have forward slashes ('/') in them which would cause conflicts with the browser's own url interpreter. For this reason, the supplied id must have all its '/' characters replaced with commas (',').

locale - The locale for which to get translations.

messageBody - The translations to modify.

extensions - The translation extension types to modify (e.g. "comment"). This parameter allows multiple values.

merge - Indicates how to deal with existing translations (valid options: 'auto', 'import'). Import will overwrite all current values with the values being pushed (even empty ones), while Auto will check the history of your translations and will not overwrite any translations for which it detects a previous value is being pushed.

Returns:

The following response status codes will be returned from this operation:
OK(200) - Translations were successfully updated.
NOT FOUND(404) - If a project, project iteration or document could not be found with the given parameters.
UNAUTHORIZED(401) - If the user does not have the proper permissions to perform this operation.
BAD REQUEST(400) - If there are problems with the parameters passed. i.e. Merge type is not one of the accepted types. This response should have a content message indicating a reason.
INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.