org.zanata.rest.client

Interface IProjectIterationResource

All Superinterfaces:

ProjectIterationResource

public interface IProjectIterationResource
extends ProjectIterationResource

Field Summary

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

ITERATION_SLUG_TEMPLATE, SERVICE_PATH

Method Summary

Methods

Modifier and Type	Method and Description
org.jboss.resteasy.client.ClientResponse<ProjectIteration>	get() Returns data for a single Project iteration.
org.jboss.resteasy.client.ClientResponse	put(ProjectIteration project) Creates or modifies a Project iteration.
org.jboss.resteasy.client.ClientResponse	sampleConfiguration() Get a project iteration's sample general configuration file(zanata.xml).

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

head

Method Detail

get

org.jboss.resteasy.client.ClientResponse<ProjectIteration> get()

Description copied from interface: ProjectIterationResource

Returns data for a single Project iteration.

Specified by:

get in interface ProjectIterationResource

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

org.jboss.resteasy.client.ClientResponse put(ProjectIteration project)

Description copied from interface: ProjectIterationResource

Creates or modifies a Project iteration.

Specified by:

put in interface ProjectIterationResource

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

org.jboss.resteasy.client.ClientResponse sampleConfiguration()

Description copied from interface: ProjectIterationResource

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.

Specified by:

sampleConfiguration in interface ProjectIterationResource

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.