git.aero2k.de Git - tmp/jakarta-migration.git/blob

   1 package org.collectionspace.services.client;
   2
   3 import org.jboss.resteasy.client.ClientResponse;
   4 import javax.ws.rs.Consumes;
   5 import javax.ws.rs.GET;
   6 import javax.ws.rs.Path;
   7 import javax.ws.rs.PathParam;
   8 import javax.ws.rs.Produces;
   9 import javax.ws.rs.QueryParam;
  10
  11 import org.collectionspace.services.client.workflow.WorkflowClient;
  12 import org.collectionspace.services.location.LocationauthoritiesCommonList;
  13 import org.collectionspace.services.location.LocationsCommonList;
  14
  15 /**
  16  * @version $Revision:$
  17  * ILT = Item list type
  18  * LT = List type
  19  */
  20 @Path(LocationAuthorityClient.SERVICE_PATH + "/")
  21 @Produces("application/xml")
  22 @Consumes("application/xml")
  23 public interface LocationAuthorityProxy extends AuthorityProxy<LocationauthoritiesCommonList, LocationsCommonList> {
  24
  25     // List Locationauthorities
  26     @GET
  27     ClientResponse<LocationauthoritiesCommonList> readList();
  28
  29     /*
  30      * List results that must be overridden for the RESTEasy proxy generation to work correctly.
  31      */
  32
  33     // List Items matching a partial term or keywords.
  34     @Override
  35         @GET
  36     @Produces({"application/xml"})
  37     @Path("/{csid}/items/")
  38     ClientResponse<LocationsCommonList> readItemList(
  39                 @PathParam("csid") String vcsid,
  40             @QueryParam (IQueryManager.SEARCH_TYPE_PARTIALTERM) String partialTerm,
  41             @QueryParam(IQueryManager.SEARCH_TYPE_KEYWORDS_KW) String keywords,
  42             @QueryParam(WorkflowClient.WORKFLOW_QUERY_NONDELETED) String includeDeleted);
  43
  44     // List Items for a named authority matching a partial term or keywords.
  45     @Override
  46         @GET
  47     @Produces({"application/xml"})
  48     @Path("/urn:cspace:name({specifier})/items/")
  49     ClientResponse<LocationsCommonList> readItemListForNamedAuthority(
  50                 @PathParam("specifier") String specifier,
  51             @QueryParam (IQueryManager.SEARCH_TYPE_PARTIALTERM) String partialTerm,
  52             @QueryParam(IQueryManager.SEARCH_TYPE_KEYWORDS_KW) String keywords,
  53             @QueryParam(WorkflowClient.WORKFLOW_QUERY_NONDELETED) String includeDeleted);
  54
  55     @Override
  56         @GET
  57     @Produces({"application/xml"})
  58     ClientResponse<LocationauthoritiesCommonList> readIncludeDeleted(
  59             @QueryParam(WorkflowClient.WORKFLOW_QUERY_NONDELETED) String includeDeleted);
  60
  61     @Override
  62     @GET
  63     @Produces({"application/xml"})
  64     ClientResponse<LocationauthoritiesCommonList> keywordSearchIncludeDeleted(
  65                 @QueryParam(IQueryManager.SEARCH_TYPE_KEYWORDS_KW) String keywords,
  66             @QueryParam(WorkflowClient.WORKFLOW_QUERY_NONDELETED) String includeDeleted);
  67 }