org.zanata.rest.client

Interface IGlossaryResource

All Superinterfaces:

GlossaryResource

@Path(value="/glossary")
 @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 IGlossaryResource
extends GlossaryResource

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_PATH

Method Summary

Modifier and Type	Method and Description
org.jboss.resteasy.client.ClientResponse<String>	deleteGlossaries() Delete all glossary terms.
org.jboss.resteasy.client.ClientResponse<String>	deleteGlossary(LocaleId locale) Delete all glossary terms with the specified locale.
org.jboss.resteasy.client.ClientResponse<Glossary>	get(LocaleId locale) Returns Glossary entries for a single locale.
org.jboss.resteasy.client.ClientResponse<Glossary>	getEntries() Returns all Glossary entries.
org.jboss.resteasy.client.ClientResponse<String>	put(Glossary glossary) 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"})
org.jboss.resteasy.client.ClientResponse<Glossary> getEntries()

Description copied from interface: GlossaryResource

Returns all Glossary entries.

Specified by:

getEntries in interface GlossaryResource

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"})
org.jboss.resteasy.client.ClientResponse<Glossary> get(@PathParam(value="locale")
                                                                                                                                                                                                                            LocaleId locale)

Description copied from interface: GlossaryResource

Returns Glossary entries for a single locale.

Specified by:

get in interface GlossaryResource

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
org.jboss.resteasy.client.ClientResponse<String> put(Glossary glossary)

Description copied from interface: GlossaryResource

Adds glossary entries.

Specified by:

put in interface GlossaryResource

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}")
org.jboss.resteasy.client.ClientResponse<String> deleteGlossary(@PathParam(value="locale")
                                                                                                  LocaleId locale)

Description copied from interface: GlossaryResource

Delete all glossary terms with the specified locale.

Specified by:

deleteGlossary in interface GlossaryResource

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
org.jboss.resteasy.client.ClientResponse<String> deleteGlossaries()

Description copied from interface: GlossaryResource

Delete all glossary terms.

Specified by:

deleteGlossaries in interface GlossaryResource

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.