org.zanata.rest.service

Interface ProjectIterationResource

All Known Subinterfaces:

IProjectIterationResource

public interface ProjectIterationResource

projectSlug: Project Identifier. iterationSlug: Project Iteration identifier.

Author:

Sean Flanigan sflaniga@redhat.com

Field Summary

Fields

Modifier and Type	Field and Description
static String	ITERATION_SLUG_TEMPLATE
static String	SERVICE_PATH

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	get() Returns data for a single Project iteration.
javax.ws.rs.core.Response	head() Returns header information for a project iteration.
javax.ws.rs.core.Response	put(ProjectIteration project) Creates or modifies a Project iteration.
javax.ws.rs.core.Response	sampleConfiguration() Get a project iteration's sample general configuration file(zanata.xml).

Field Detail

ITERATION_SLUG_TEMPLATE

static final String ITERATION_SLUG_TEMPLATE

See Also:

Constant Field Values

SERVICE_PATH

static final String SERVICE_PATH

See Also:

Constant Field Values

Method Detail

head

javax.ws.rs.core.Response head()

Returns header information for a project iteration.

Returns:

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

get

javax.ws.rs.core.Response get()

Returns data for a single Project iteration.

Returns:

The following response status codes will be returned from this operation:
OK(200) - Contains the Project iteration data.
NOT FOUND(404) - response, if a Project iteration could not be found for the given parameters.
INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.

put

javax.ws.rs.core.Response put(ProjectIteration project)

Creates or modifies a Project iteration.

Parameters:

projectIteration - The project iteration information.

Returns:

The following response status codes will be returned from this operation:
OK(200) - If an already existing project iteration was updated as a result of this operation.
CREATED(201) - If a new project iteration was added.
NOT FOUND(404) - If no project was found for the given project slug.
FORBIDDEN(403) - If the user was not allowed to create/modify the project iteration. In this case an error message is contained in the response.
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.

sampleConfiguration

javax.ws.rs.core.Response sampleConfiguration()

Get a project iteration's sample general configuration file(zanata.xml). Note: this will only be a sample configuration which does not contain any customization done on the client side, such as, locale mapping and/or command hooks.

Returns:

The following response status codes will be returned from this operation:
OK(200) - Contains the Project iteration config xml.
NOT FOUND(404) - response, if a Project iteration could not be found for the given parameters.
INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.