clarify javadocs

git-svn-id: https://svn.apache.org/repos/asf/archiva/trunk@1185035 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Olivier Lamy 2011-10-17 07:57:46 +00:00
parent d10f2e2ef2
commit 571c271b34
1 changed files with 13 additions and 0 deletions

View File

@ -51,6 +51,9 @@ public interface SearchService
@GET
@Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
@RedbackAuthorization( noPermission = true, noRestriction = false )
/**
* <b>search will be apply on all repositories the user used has karma</b>
*/
List<Artifact> quickSearch( @QueryParam( "queryString" ) String queryString )
throws ArchivaRestServiceException;
@ -58,6 +61,9 @@ public interface SearchService
@GET
@Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
@RedbackAuthorization( noPermission = true, noRestriction = false )
/**
* <b>search will be apply on all repositories the user used has karma</b>
*/
List<Artifact> getArtifactVersions( @QueryParam( "groupId" ) String groupId,
@QueryParam( "artifactId" ) String artifactId,
@QueryParam( "packaging" ) String packaging )
@ -67,6 +73,10 @@ public interface SearchService
@POST
@Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
@RedbackAuthorization( noPermission = true, noRestriction = false )
/**
* If searchRequest contains repositories, the search will be done only on those repositories.
* <b>if no repositories, the search will be apply on all repositories the user used has karma</b>
*/
List<Artifact> searchArtifacts( SearchRequest searchRequest )
throws ArchivaRestServiceException;
@ -74,6 +84,9 @@ public interface SearchService
@GET
@Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )
@RedbackAuthorization( noPermission = true, noRestriction = false )
/**
* <b>this method applies on Maven Indexer lucene index, so datas not yet indexed won't be available</b>
*/
GroupIdList getAllGroupIds( @QueryParam( "selectedRepos" ) List<String> selectedRepos )
throws ArchivaRestServiceException;