org.zanata.rest.client

Interface IProjectResource

All Superinterfaces:

ProjectResource

@Produces(value={"application/xml","application/json"})
 @Consumes(value={"application/xml","application/json"})
public interface IProjectResource
extends ProjectResource

Field Summary

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

PROJECT_SLUG_TEMPLATE, SERVICE_PATH

Method Summary

Modifier and Type	Method and Description
org.jboss.resteasy.client.ClientResponse<Project>	get() Returns data for a single Project.
org.jboss.resteasy.client.ClientResponse	head() Returns header information for a project.
org.jboss.resteasy.client.ClientResponse	put(Project project) Creates or modifies a Project.

Method Detail

head

@HEAD
 @Produces(value={"application/vnd.zanata.project+xml","application/vnd.zanata.project+json","application/xml","application/json"})
org.jboss.resteasy.client.ClientResponse head()

Description copied from interface: ProjectResource

Returns header information for a project.

Specified by:

head in interface ProjectResource

Returns:

The following response status codes will be returned from this operation:
OK(200) - An "Etag" header for the requested project.
NOT FOUND(404) - If a project 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

@GET
 @Produces(value={"application/vnd.zanata.project+xml","application/vnd.zanata.project+json","application/xml","application/json"})
org.jboss.resteasy.client.ClientResponse<Project> get()

Description copied from interface: ProjectResource

Returns data for a single Project.

Specified by:

get in interface ProjectResource

Returns:

The following response status codes will be returned from this operation:
OK(200) - Containing the Project data.
NOT FOUND(404) - If a Project 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

@PUT
 @Consumes(value={"application/vnd.zanata.project+xml","application/vnd.zanata.project+json","application/xml","application/json"})
org.jboss.resteasy.client.ClientResponse put(Project project)

Description copied from interface: ProjectResource

Creates or modifies a Project.

Specified by:

put in interface ProjectResource

Parameters:

project - The project's information.

Returns:

The following response status codes will be returned from this method:
OK(200) - If an already existing project was updated as a result of this operation.
CREATED(201) - If a new project was added.
FORBIDDEN(403) - If the user was not allowed to create/modify the project. 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.