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

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