net.caspervg.lex4j.route

Class LotRoute

java.lang.Object

net.caspervg.lex4j.route.LotRoute

public class LotRoute
extends java.lang.Object

Routing for the Lot Endpoint. Attention: methods can throw ResourceExceptions.

See Also:

Restlet Status API Javadoc, LEX API Overview on Github Created with IntelliJ IDEA. User: Casper Date: 21/11/13 Time: 19:11

Field Summary

Fields

Modifier and Type	Field and Description
private Auth	auth

Constructor Summary

Constructors

Constructor and Description
LotRoute() Creates a new LotRoute, without Authorisation token.
LotRoute(Auth auth) Creates a new LotRoute, with Authorisation token.

Method Summary

Modifier and Type	Method and Description
java.util.List<Comment>	getComment(int id) Retrieves the list of comments for a lot/file
DependencyList	getDependency(int id) Retrieves the dependency list for a lot/file
Lot	getLot(int id) Retrieve the lot/file
boolean	getLotDownload(int id, java.io.File directory) Downloads a lot/file
java.util.List<Lot>	getLotList() Retrieve a list of lots/files
void	postComment(int id, int rating, java.lang.String comment) Adds a comment and/or rating to a lot/file
void	putLotDownloadList(int id) Adds a file to the user's download list

Methods inherited from class java.lang.Object

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

Field Detail

auth

private Auth auth

Constructor Detail

LotRoute

public LotRoute()

Creates a new LotRoute, without Authorisation token. Some functions may not work!

LotRoute

public LotRoute(Auth auth)

Creates a new LotRoute, with Authorisation token.

Parameters:

auth - Authentication token

Method Detail

getLot

public Lot getLot(int id)

Retrieve the lot/file

Parameters:

id - ID of the lot to be retrieved

Returns:

Lot

getLotList

public java.util.List<Lot> getLotList()

Retrieve a list of lots/files

Returns:

List of lots/files

getLotDownload

public boolean getLotDownload(int id,
                              java.io.File directory)

Downloads a lot/file

Parameters:

id - ID of the lot/file

directory - Directory where the file should be downloaded

Returns:

Download succeeded

Requires:

Authentication

putLotDownloadList

public void putLotDownloadList(int id)

Adds a file to the user's download list

Parameters:

id - : ID of the lot/file

Requires:

Authentication

getComment

public java.util.List<Comment> getComment(int id)

Retrieves the list of comments for a lot/file

Parameters:

id - ID of the lot/file

Returns:

List of comments

postComment

public void postComment(int id,
                        int rating,
                        java.lang.String comment)

Adds a comment and/or rating to a lot/file

Parameters:

id - ID of the lot/file

rating - rating for the lot/file (can be null)

comment - comment for the lot/file (can be null)

Requires:

Authentication

getDependency

public DependencyList getDependency(int id)

Retrieves the dependency list for a lot/file

Parameters:

id - ID of the lot/file

Returns:

DependencyList