001/**
002 * Copyright 2005-2011 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.ksb.messaging.remotedservices;
017
018import javax.ws.rs.Consumes;
019import javax.ws.rs.DELETE;
020import javax.ws.rs.GET;
021import javax.ws.rs.POST;
022import javax.ws.rs.PUT;
023import javax.ws.rs.Path;
024import javax.ws.rs.PathParam;
025import javax.ws.rs.Produces;
026
027/**
028 * RESTful service interface for an inbox
029 *
030 * @author Kuali Rice Team (rice.collab@kuali.org)
031 *
032 */
033@Path("inbox")
034public interface InboxResource {
035
036        @POST
037        @Produces("application/xml")
038        @Consumes("application/xml")
039        public Inbox createInbox(Inbox inbox);
040
041        @GET
042        @Path("{id}")
043        @Produces("application/xml")
044        public Inbox retrieveInbox(@PathParam("id") String id);
045
046        @PUT
047        @Consumes("application/xml")
048        public void updateInbox(Inbox inbox);
049
050        @DELETE
051        public void deleteInbox(@PathParam("id") String id);
052
053
054        public MessageResource getMessageResource();
055
056}