org.zanata.rest.service

Interface GlossaryResource

All Known Subinterfaces:

IGlossaryResource

@Produces(value={"application/xml","application/json","application/vnd.zanata.glossary+xml","application/vnd.zanata.glossary+json"})
 @Consumes(value={"application/xml","application/json","application/vnd.zanata.glossary+xml","application/vnd.zanata.glossary+json"})
public interface GlossaryResource

Author:

Alex Eng aeng@redhat.com

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_PATH

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	deleteGlossaries() Delete all glossary terms.
javax.ws.rs.core.Response	deleteGlossary(LocaleId locale) Delete all glossary terms with the specified locale.
javax.ws.rs.core.Response	get(LocaleId locale) Returns Glossary entries for a single locale.
javax.ws.rs.core.Response	getEntries() Returns all Glossary entries.
javax.ws.rs.core.Response	put(Glossary messageBody) Adds glossary entries.

Field Detail

SERVICE_PATH

static final String SERVICE_PATH

See Also:

Constant Field Values

Method Detail

getEntries

@GET
 @Produces(value={"application/vnd.zanata.glossary+xml","application/vnd.zanata.glossary+json","application/xml","application/json"})
javax.ws.rs.core.Response getEntries()

Returns all Glossary entries.

Returns:

The following response status codes will be returned from this operation:
OK(200) - Response containing all Glossary entries in the system. INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.

get

@GET
 @Path(value="/{locale}")
 @Produces(value={"application/vnd.zanata.glossary+xml","application/vnd.zanata.glossary+json","application/xml","application/json"})
javax.ws.rs.core.Response get(@PathParam(value="locale")
                                                                                                                                                                                                   LocaleId locale)

Returns Glossary entries for a single locale.

Parameters:

locale - Locale for which to retrieve entries.

Returns:

The following response status codes will be returned from this operation:
OK(200) - Response containing all Glossary entries for the given locale. INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.

put

@PUT
javax.ws.rs.core.Response put(Glossary messageBody)

Adds glossary entries.

Parameters:

glossary - The Glossary entries to add.

Returns:

The following response status codes will be returned from this operation:
CREATED(201) - If the glossary entries were successfully created. 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.

deleteGlossary

@DELETE
 @Path(value="/{locale}")
javax.ws.rs.core.Response deleteGlossary(@PathParam(value="locale")
                                                                           LocaleId locale)

Delete all glossary terms with the specified locale.

Parameters:

targetLocale - The target locale to delete glossary entries from.

Returns:

The following response status codes will be returned from this operation:
OK(200) - If the glossary entries were successfully deleted. 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.

deleteGlossaries

@DELETE
javax.ws.rs.core.Response deleteGlossaries()

Delete all glossary terms.

Returns:

The following response status codes will be returned from this operation:
OK(200) - If the glossary entries were successfully deleted. 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.