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.DELETE;
   5 import javax.ws.rs.GET;
   6 import javax.ws.rs.POST;
   7 import javax.ws.rs.PUT;
   8 import javax.ws.rs.Path;
   9 import javax.ws.rs.PathParam;
  10 import javax.ws.rs.Produces;
  11 import javax.ws.rs.QueryParam;
  12 import javax.ws.rs.core.Response;
  13
  14 import org.collectionspace.services.common.query.IQueryManager;
  15 import org.collectionspace.services.common.authorityref.AuthorityRefDocList;
  16 import org.collectionspace.services.contact.ContactsCommonList;
  17 import org.collectionspace.services.location.LocationauthoritiesCommonList;
  18 import org.collectionspace.services.location.LocationsCommonList;
  19 import org.jboss.resteasy.client.ClientResponse;
  20
  21 /**
  22  * @version $Revision:$
  23  */
  24 @Path(LocationAuthorityClient.SERVICE_PATH + "/")
  25 @Produces("application/xml")
  26 @Consumes("application/xml")
  27 public interface LocationAuthorityProxy extends CollectionSpaceProxy {
  28
  29     // List Locationauthorities
  30     @GET
  31     ClientResponse<LocationauthoritiesCommonList> readList();
  32
  33     //(C)reate
  34     @POST
  35     ClientResponse<Response> create(byte[] xmlPayload);
  36
  37     //(R)ead
  38     @GET
  39     @Path("/{csid}")
  40     ClientResponse<String> read(@PathParam("csid") String csid);
  41
  42     //(R)ead by name
  43     @GET
  44     @Path("/urn:cspace:name({name})")
  45     ClientResponse<String> readByName(@PathParam("name") String name);
  46
  47     //(U)pdate
  48     @PUT
  49     @Path("/{csid}")
  50     ClientResponse<String> update(@PathParam("csid") String csid, byte[] xmlPayload);
  51
  52     //(D)elete
  53     @DELETE
  54     @Path("/{csid}")
  55     ClientResponse<Response> delete(@PathParam("csid") String csid);
  56
  57     // List Items matching a partial term or keywords.
  58     @GET
  59     @Produces({"application/xml"})
  60     @Path("/{vcsid}/items/")
  61     ClientResponse<LocationsCommonList> readItemList(
  62                 @PathParam("vcsid") String vcsid,
  63             @QueryParam (IQueryManager.SEARCH_TYPE_PARTIALTERM) String partialTerm,
  64             @QueryParam(IQueryManager.SEARCH_TYPE_KEYWORDS_KW) String keywords);
  65
  66     /**
  67      * @param parentcsid
  68      * @param itemcsid
  69      * @param csid
  70      * @return
  71      * @see org.collectionspace.services.client.IntakeProxy#getAuthorityRefs(java.lang.String)
  72      */
  73     @GET
  74     @Path("{csid}/items/{itemcsid}/refObjs")
  75     @Produces("application/xml")
  76     ClientResponse<AuthorityRefDocList> getReferencingObjects(
  77             @PathParam("csid") String parentcsid,
  78             @PathParam("itemcsid") String itemcsid);
  79
  80     // List Items for a named authority matching a partial term or keywords.
  81     @GET
  82     @Produces({"application/xml"})
  83     @Path("/urn:cspace:name({specifier})/items/")
  84     ClientResponse<LocationsCommonList> readItemListForNamedAuthority(
  85                 @PathParam("specifier") String specifier,
  86             @QueryParam (IQueryManager.SEARCH_TYPE_PARTIALTERM) String partialTerm,
  87             @QueryParam(IQueryManager.SEARCH_TYPE_KEYWORDS_KW) String keywords);
  88
  89     //(C)reate Item
  90     @POST
  91     @Path("/{vcsid}/items/")
  92     ClientResponse<Response> createItem(@PathParam("vcsid") String vcsid, byte[] xmlPayload);
  93
  94     //(R)ead Item
  95     @GET
  96     @Path("/{vcsid}/items/{csid}")
  97     ClientResponse<String> readItem(@PathParam("vcsid") String vcsid, @PathParam("csid") String csid);
  98
  99     //(U)pdate Item
 100     @PUT
 101     @Path("/{vcsid}/items/{csid}")
 102     ClientResponse<String> updateItem(@PathParam("vcsid") String vcsid, @PathParam("csid") String csid, byte[] xmlPayload);
 103
 104     //(D)elete Item
 105     @DELETE
 106     @Path("/{vcsid}/items/{csid}")
 107     ClientResponse<Response> deleteItem(@PathParam("vcsid") String vcsid, @PathParam("csid") String csid);
 108
 109      // List Contacts
 110     @GET
 111     @Path("/{parentcsid}/items/{itemcsid}/contacts/")
 112     ClientResponse<ContactsCommonList> readContactList(
 113             @PathParam("parentcsid") String parentcsid,
 114             @PathParam("itemcsid") String itemcsid);
 115
 116     //(C)reate Contact
 117     @POST
 118     @Path("/{parentcsid}/items/{itemcsid}/contacts/")
 119     ClientResponse<Response> createContact(
 120             @PathParam("parentcsid") String parentcsid,
 121             @PathParam("itemcsid") String itemcsid,
 122             byte[] xmlPayload);
 123
 124      //(R)ead Contact
 125     @GET
 126     @Path("/{parentcsid}/items/{itemcsid}/contacts/{csid}")
 127     ClientResponse<String> readContact(
 128             @PathParam("parentcsid") String parentcsid,
 129             @PathParam("itemcsid") String itemcsid,
 130             @PathParam("csid") String csid);
 131
 132     //(U)pdate Contact
 133     @PUT
 134     @Path("/{parentcsid}/items/{itemcsid}/contacts/{csid}")
 135     ClientResponse<String> updateContact(
 136             @PathParam("parentcsid") String parentcsid,
 137             @PathParam("itemcsid") String itemcsid,
 138             @PathParam("csid") String csid,
 139             byte[] xmlPayload);
 140
 141     //(D)elete Contact
 142     @DELETE
 143     @Path("/{parentcsid}/items/{itemcsid}/contacts/{csid}")
 144     ClientResponse<Response> deleteContact(
 145             @PathParam("parentcsid") String parentcsid,
 146             @PathParam("itemcsid") String itemcsid,
 147             @PathParam("csid") String csid);
 148
 149 }