/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2013 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.jersey.samples.hypermedia.client.controller;
import com.sun.jersey.core.hypermedia.Action;
import com.sun.jersey.core.hypermedia.HypermediaController;
import com.sun.jersey.core.hypermedia.HypermediaController.LinkType;
import com.sun.jersey.core.hypermedia.Name;
import com.sun.jersey.samples.hypermedia.client.model.Address;
import com.sun.jersey.samples.hypermedia.client.model.Order;
import javax.ws.rs.Consumes;
import javax.ws.rs.POST;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
/**
* OrderController class.
*
* @author Santiago.PericasGeertsen@sun.com
*/
@HypermediaController(
model=Order.class,
linkType=LinkType.LINK_HEADERS
)
public interface OrderController {
/**
* Returns client copy of model from local cache.
*/
public Order getModel();
/**
* Refreshes client copy of model in local cache. Uses
* @Produces to select a specific representation.
*/
@Action("refresh")
@Produces("application/xml")
public Order refresh();
/**
* Updates server copy of model using local cache. Unannotated
* parameter <code>newOrder</code> becomes the request's entity.
* Uses @Consumes to indicate how to serialize order.
*/
@Action("update")
@Consumes("application/xml")
public void update(Order newOrder);
/**
* Sets status to REVIEWED and adds notes. Parameter
* <code>notes</code> is mapped dynamically using WADL.
*/
@Action("review")
public void review(@Name("notes") String notes);
/**
* Set status to PAID and optionally use new card number.
* Parameter <code>newCardNumber</code> is mapped statically
* using @QueryParam. HTTP method is statically set to @POST
* and must match the HTTP method in the link header.
*/
@POST
@Action("pay")
public void pay(@QueryParam("newCardNumber") String newCardNumber);
/**
* Sets status to shipped and optionally specify new address.
* Unannotated parameter <code>newShippingAddress</code>
* becomes the request's entity.
*/
@Action("ship")
public Order ship(Address newShippingAddress);
/**
* Cancels an order and adds notes. Parameter
* <code>notes</code> is mapped dynamically using WADL.
*/
@Action("cancel")
public void cancel(@Name("notes") String notes);
}