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.client.workflow.WorkflowClient;
  39 import org.collectionspace.services.collectionobject.CollectionobjectsCommonList;
  40
  41 /**
  42  * @version $Revision:$
  43  * FIXME: http://issues.collectionspace.org/browse/CSPACE-1684
  44  */
  45 @Path(CollectionObjectClient.SERVICE_PATH_PROXY)
  46 @Produces({"application/xml"})
  47 @Consumes({"application/xml"})
  48 public interface CollectionObjectProxy extends CollectionSpacePoxProxy<CollectionobjectsCommonList> {
  49
  50     /**
  51      * Roundtrip.
  52      * @param ms
  53      *
  54      * @return the client response
  55      */
  56     @GET
  57     @Path("/{ms}/roundtrip")
  58     @Produces({"application/xml"})
  59     ClientResponse<Response> roundtrip(@PathParam("ms") int ms);
  60
  61     /**
  62      * Read list.
  63      *
  64      * @return the client response
  65      */
  66     @GET
  67     @Produces({"application/xml"})
  68     ClientResponse<CollectionobjectsCommonList> readList();
  69
  70     @Override
  71         @GET
  72     @Produces({"application/xml"})
  73     ClientResponse<CollectionobjectsCommonList> readIncludeDeleted(
  74             @QueryParam(WorkflowClient.WORKFLOW_QUERY_NONDELETED) String includeDeleted);
  75
  76     /**
  77      * Keyword search.
  78      *
  79      * @param keywords the keywords
  80      * @return the client response
  81      */
  82     @GET
  83     @Produces({"application/xml"})
  84     ClientResponse<CollectionobjectsCommonList> keywordSearch(
  85                 @QueryParam(IQueryManager.SEARCH_TYPE_KEYWORDS_KW) String keywords);
  86
  87     @Override
  88     @GET
  89     @Produces({"application/xml"})
  90     ClientResponse<CollectionobjectsCommonList> keywordSearchIncludeDeleted(
  91             @QueryParam(IQueryManager.SEARCH_TYPE_KEYWORDS_KW) String keywords,
  92             @QueryParam(WorkflowClient.WORKFLOW_QUERY_NONDELETED) String includeDeleted);
  93
  94 }