Package com.gentics.contentnode.rest.resource

Interface LanguageResource

@Produces("application/json")
@Consumes("application/json")
@Path("language")
public interface LanguageResource

Resource to manage cms languages

Method Summary

Modifier and Type	Method	Description
ContentLanguageResponse	create(ContentLanguage language)	Create a new content language
javax.ws.rs.core.Response	delete(String id)	Delete the language with given ID
ContentLanguageResponse	get(String id)	Load the language with given id
LanguageListResponse	list()	Deprecated.
LanguageList	list(FilterParameterBean filter, SortParameterBean sorting, PagingParameterBean paging)	Load a list of languages. The result can be filtered by id globalId name code and sorted by id globalId name code
ContentLanguageResponse	update(String id, ContentLanguage language)	Update the language with given id

Method Details

list

@GET
LanguageList list(@BeanParam
 FilterParameterBean filter,
 @BeanParam
 SortParameterBean sorting,
 @BeanParam
 PagingParameterBean paging)
           throws Exception

Load a list of languages.
The result can be filtered by

• id
• globalId
• name
• code

and sorted by

• id
• globalId
• name
• code

Parameters:

filter - filter parameters

sorting - sorting parameters

paging - paging parameters

Returns:

response containing a list of languages

Throws:

Exception

create

@POST
ContentLanguageResponse create(ContentLanguage language)
                        throws Exception

Create a new content language

Parameters:

language - language

Returns:

Response containing the created content language

Throws:

Exception

get

@GET
@Path("/{id}")
ContentLanguageResponse get(@PathParam("id")
 String id)
                     throws Exception

Load the language with given id

Parameters:

id - language ID

Returns:

Response containing the requested language

Throws:

Exception

update

@PUT
@Path("/{id}")
ContentLanguageResponse update(@PathParam("id")
 String id,
 ContentLanguage language)
                        throws Exception

Update the language with given id

Parameters:

id - language ID

language - Updated language

Returns:

Response containing the updated language

Throws:

Exception

delete

@DELETE
@Path("/{id}")
javax.ws.rs.core.Response delete(@PathParam("id")
 String id)
                          throws Exception

Delete the language with given ID

Parameters:

id - language ID

Returns:

empty response

Throws:

Exception

list

@GET
@Path("list")
LanguageListResponse list()
                   throws Exception

Deprecated.

Load all available languages

Returns:

list of available languages

Throws:

Exception