Package org.ctan.site.resources.admin

Class TexArchiveNotes3Resource

java.lang.Object

org.ctan.site.resources.admin.TexArchiveNotes3Resource

@Path("/3.0/admin")
@Produces("application/json")
@RolesAllowed("ADMIN")
public class TexArchiveNotes3Resource
extends Object

The class TexArchiveNotes3Resource contains the CRUD controller for the tex-archive notes resource.

Constructor Summary

Constructors

Constructor	Description
TexArchiveNotes3Resource(@NonNull TexArchiveNotesStore store)	This is the constructor for the class TexArchiveNotes3Resource.

Method Summary

Modifier and Type	Method	Description
TexArchiveNotes	get(@NonNull Long id)	The method retrieve provides means to retrieve a texarchive-notes.
GeneralPage	list(String q, int page, int size, String orderBy, boolean asc)	The method list provides means to retrieve a page of texarchive-notes.
boolean	remove(@NonNull Long id)	The method remove provides an end-point to remove a texarchive-notes.
TexArchiveNotes	save(@NonNull TexArchiveNotes notes)	The method save provides an end-point to create a notes object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TexArchiveNotes3Resource

public TexArchiveNotes3Resource(@NonNull
 @NonNull TexArchiveNotesStore store)

This is the constructor for the class TexArchiveNotes3Resource.

Parameters:

store - the underlying store

Method Details

get

@GET
@Path("/tex-archive-note/{id}")
@UnitOfWork("siteDb")
public TexArchiveNotes get(@NonNull @PathParam("id")
 @NonNull Long id)

The method retrieve provides means to retrieve a texarchive-notes.

Parameters:

id - the id

Returns:

true iff the texarchive-note exists

list

@GET
@Path("/tex-archive-notes")
@UnitOfWork("siteDb")
public GeneralPage list(@QueryParam("q")
 String q,
 @QueryParam("page")
 int page,
 @QueryParam("size")
 int size,
 @QueryParam("order")
 String orderBy,
 @QueryParam("asc")
 boolean asc)

The method list provides means to retrieve a page of texarchive-notes.

Parameters:

q - the name pattern

page - the page

size - the page size

orderBy - the order

asc - the indicator for ascending

Returns:

the page for the texarchive-notes or null

remove

@DELETE
@Path("/tex-archive-note/{id}")
@UnitOfWork("siteDb")
public boolean remove(@NonNull @PathParam("id")
 @NonNull Long id)

The method remove provides an end-point to remove a texarchive-notes.

Parameters:

id - the id

Returns:

true iff the texarchive-notes has existed

save

@POST
@Path("/tex-archive-note")
@UnitOfWork("siteDb")
public TexArchiveNotes save(@NonNull
 @NonNull TexArchiveNotes notes)

The method save provides an end-point to create a notes object.

Parameters:

notes - the notes object to store

Returns:

true iff something has been removed