org.zanata.rest.service

Interface CopyTransResource

All Known Subinterfaces:

ICopyTransResource

public interface CopyTransResource

Author:

Carlos Munoz camunoz@redhat.com

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_PATH

Method Summary

Methods

Modifier and Type	Method and Description
CopyTransStatus	getCopyTransStatus(String projectSlug, String iterationSlug, String docId) Retrieves the status for a Translation copy process for a document.
CopyTransStatus	startCopyTrans(String projectSlug, String iterationSlug, String docId) Starts a Translation copy for an individual document.

Field Detail

SERVICE_PATH

static final String SERVICE_PATH

See Also:

Constant Field Values

Method Detail

startCopyTrans

CopyTransStatus startCopyTrans(String projectSlug,
                             String iterationSlug,
                             String docId)

Starts a Translation copy for an individual document.

Parameters:

projectSlug - Project identifier

iterationSlug - Project version identifier

docId - Document Id to copy translations into.

Returns:

The following response status codes will be returned from this operation:
OK(200) - Translation copy was started for the given document. The status of the process is also returned in the response contents.
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. Translation copy will not start in this case.

getCopyTransStatus

CopyTransStatus getCopyTransStatus(String projectSlug,
                                 String iterationSlug,
                                 String docId)

Retrieves the status for a Translation copy process for a document.

Parameters:

projectSlug - Project identifier

iterationSlug - Project version identifier

docId - Document Id

Returns:

The following response status codes will be returned from this operation:
OK(200) - A Translation copy process was found, and its status will be returned in the body of the response.
NOT_FOUND(404) - If there is no record of a recent translation copy process for the specified document. INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.