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

   1 /**
   2  * CollectionObjectProxy.java
   3  *
   4  * {Purpose of This Class}
   5  *
   6  * {Other Notes Relating to This Class (Optional)}
   7  *
   8  * $LastChangedBy: $
   9  * $LastChangedRevision: $
  10  * $LastChangedDate: $
  11  *
  12  * This document is a part of the source code and related artifacts
  13  * for CollectionSpace, an open source collections management system
  14  * for museums and related institutions:
  15  *
  16  * http://www.collectionspace.org
  17  * http://wiki.collectionspace.org
  18  *
  19  * Copyright © 2009 {Contributing Institution}
  20  *
  21  * Licensed under the Educational Community License (ECL), Version 2.0.
  22  * You may not use this file except in compliance with this License.
  23  *
  24  * You may obtain a copy of the ECL 2.0 License at
  25  * https://source.collectionspace.org/collection-space/LICENSE.txt
  26  */
  27 package org.collectionspace.services.client;
  28
  29 import org.jboss.resteasy.client.ClientResponse;
  30 import javax.ws.rs.Consumes;
  31 import javax.ws.rs.GET;
  32 import javax.ws.rs.Path;
  33 import javax.ws.rs.PathParam;
  34 import javax.ws.rs.QueryParam;
  35 import javax.ws.rs.Produces;
  36 import javax.ws.rs.core.Response;
  37
  38 import org.collectionspace.services.collectionobject.CollectionobjectsCommonList;
  39
  40 /**
  41  * @version $Revision:$
  42  * FIXME: http://issues.collectionspace.org/browse/CSPACE-1684
  43  */
  44 @Path(CollectionObjectClient.SERVICE_PATH_PROXY)
  45 @Produces({"application/xml"})
  46 @Consumes({"application/xml"})
  47 public interface CollectionObjectProxy extends CollectionSpacePoxProxy {
  48
  49     /**
  50      * Roundtrip.
  51      * @param ms
  52      *
  53      * @return the client response
  54      */
  55     @GET
  56     @Path("/{ms}/roundtrip")
  57     @Produces({"application/xml"})
  58     ClientResponse<Response> roundtrip(@PathParam("ms") int ms);
  59
  60     /**
  61      * Read list.
  62      *
  63      * @return the client response
  64      */
  65     @GET
  66     @Produces({"application/xml"})
  67     ClientResponse<CollectionobjectsCommonList> readList();
  68
  69     /**
  70      * Keyword search.
  71      *
  72      * @param keywords the keywords
  73      * @return the client response
  74      */
  75     @GET
  76     @Produces({"application/xml"})
  77     ClientResponse<CollectionobjectsCommonList> keywordSearch(
  78                 @QueryParam(IQueryManager.SEARCH_TYPE_KEYWORDS_KW) String keywords);
  79
  80 }