org.zanata.rest.client

Interface ISourceDocResource

All Superinterfaces:

SourceDocResource

public interface ISourceDocResource
extends SourceDocResource

Client interface for Source document resources.

Author:

Carlos Munoz camunoz@redhat.com

Field Summary

Fields inherited from interface org.zanata.rest.service.SourceDocResource

RESOURCE_NAME_REGEX, RESOURCE_SLUG_REGEX, RESOURCE_SLUG_TEMPLATE, SERVICE_PATH

Method Summary

Methods

Modifier and Type	Method and Description
org.jboss.resteasy.client.ClientResponse<String>	deleteResource(String idNoSlash) Delete a Document.
org.jboss.resteasy.client.ClientResponse<List<ResourceMeta>>	get(Set<String> extensions) Retrieve the List of Documents (Resources) belonging to a Project iteration.
org.jboss.resteasy.client.ClientResponse<Resource>	getResource(String idNoSlash, Set<String> extensions) Retrieves information for a Document.
org.jboss.resteasy.client.ClientResponse<ResourceMeta>	getResourceMeta(String idNoSlash, Set<String> extensions) Retrieves meta-data information for a Document.
org.jboss.resteasy.client.ClientResponse<String>	post(Resource messageBody, Set<String> extensions, boolean copytrans) Creates a new Document.
org.jboss.resteasy.client.ClientResponse<String>	putResource(String idNoSlash, Resource resource, Set<String> extensions) Deprecated.
org.jboss.resteasy.client.ClientResponse<String>	putResource(String idNoSlash, Resource resource, Set<String> extensions, boolean copytrans) Creates or modifies a Document.
org.jboss.resteasy.client.ClientResponse<String>	putResourceMeta(String idNoSlash, ResourceMeta messageBody, Set<String> extensions) Modifies an existing document's meta-data.

Methods inherited from interface org.zanata.rest.service.SourceDocResource

head

Method Detail

get

org.jboss.resteasy.client.ClientResponse<List<ResourceMeta>> get(Set<String> extensions)

Description copied from interface: SourceDocResource

Retrieve the List of Documents (Resources) belonging to a Project iteration.

Specified by:

get in interface SourceDocResource

Parameters:

extensions - The document extensions to fetch along with the documents (e.g. "gettext", "comment"). This parameter allows multiple values e.g. "ext=gettext&ext=comment".

Returns:

The following response status codes will be returned from this operation:
OK(200) - Response with a list of documents wrapped in a "resources" element. Each child element will be a "resource-meta".
NOT FOUND(404) - If a Project iteration could not be found with the given parameters.
INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.

post

org.jboss.resteasy.client.ClientResponse<String> post(Resource messageBody,
                                                    Set<String> extensions,
                                                    boolean copytrans)

Description copied from interface: SourceDocResource

Creates a new Document.

Specified by:

post in interface SourceDocResource

Parameters:

messageBody - The document information.

extensions - The document extensions to save with the new document (e.g. "gettext", "comment"). This parameter allows multiple values e.g. "ext=gettext&ext=comment".

copytrans - Boolean value that indicates whether reasonably close translations from other projects should be found to initially populate this document's translations.

Returns:

The following response status codes will be returned from this operation:
CREATED (201) - If the document was successfully created.
CONFLICT(409) - If another document already exists with the same name, on the same project iteration.
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.

getResource

org.jboss.resteasy.client.ClientResponse<Resource> getResource(String idNoSlash,
                                                             Set<String> extensions)

Description copied from interface: SourceDocResource

Retrieves information for a Document.

Specified by:

getResource in interface SourceDocResource

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 (',').

extensions - The document extensions to fetch along with the document (e.g. "gettext", "comment"). This parameter allows multiple values e.g. "ext=gettext&ext=comment".

Returns:

The following response status codes will be returned from this operation:
OK(200) - Response with the document's information.
NOT FOUND(404) - If a document could not be found with the given parameters.
INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.

putResource

org.jboss.resteasy.client.ClientResponse<String> putResource(String idNoSlash,
                                                           Resource resource,
                                                           Set<String> extensions,
                                                           boolean copytrans)

Description copied from interface: SourceDocResource

Creates or modifies a Document.

Specified by:

putResource in interface SourceDocResource

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 (',').

resource - The document information.

extensions - The document extensions to save with the document (e.g. "gettext", "comment"). This parameter allows multiple values e.g. "ext=gettext&ext=comment".

copytrans - Boolean value that indicates whether reasonably close translations from other projects should be found to initially populate this document's translations.

Returns:

The following response status codes will be returned from this operation:
CREATED(201) - If a new document was successfully created.
OK(200) - If an already existing document was modified.
NOT FOUND(404) - If a project or project iteration could not be found with the given parameters.
FORBIDDEN(403) - If the user is not allowed to modify the project, project iteration or document. This might be due to the project or iteration being in Read-Only mode.
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.

putResource

@Deprecated
org.jboss.resteasy.client.ClientResponse<String> putResource(String idNoSlash,
                                                                      Resource resource,
                                                                      Set<String> extensions)

Deprecated.

deleteResource

org.jboss.resteasy.client.ClientResponse<String> deleteResource(String idNoSlash)

Description copied from interface: SourceDocResource

Delete a Document. The system keeps the history of this document however.

Specified by:

deleteResource in interface SourceDocResource

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 (',').

Returns:

The following response status codes will be returned from this operation:
OK(200) - If The document was successfully deleted.
NOT FOUND(404) - If a project or project iteration could not be found with the given parameters.
FORBIDDEN(403) - If the user is not allowed to modify the project, project iteration or document. This might be due to the project or iteration being in Read-Only mode.
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.

getResourceMeta

org.jboss.resteasy.client.ClientResponse<ResourceMeta> getResourceMeta(String idNoSlash,
                                                                     Set<String> extensions)

Description copied from interface: SourceDocResource

Retrieves meta-data information for a Document.

Specified by:

getResourceMeta in interface SourceDocResource

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 (',').

extensions - The document extensions to retrieve with the document's meta-data (e.g. "gettext", "comment"). This parameter allows multiple values e.g. "ext=gettext&ext=comment".

Returns:

The following response status codes will be returned from this operation:
OK(200) - If the Document's meta-data was found. 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.
INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.

putResourceMeta

org.jboss.resteasy.client.ClientResponse<String> putResourceMeta(String idNoSlash,
                                                               ResourceMeta messageBody,
                                                               Set<String> extensions)

Description copied from interface: SourceDocResource

Modifies an existing document's meta-data.

Specified by:

putResourceMeta in interface SourceDocResource

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 (',').

messageBody - The document's meta-data.

extensions - The document extensions to save with the document (e.g. "gettext", "comment"). This parameter allows multiple values e.g. "ext=gettext&ext=comment".

Returns:

The following response status codes will be returned from this operation:
OK(200) - If the Document's meta-data was successfully modified.
NOT FOUND(404) - If a document was not found using 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.