/**
    * Copyright 2011 The Kuali Foundation Licensed under the
    * Educational Community License, Version 2.0 (the "License"); you may
    * not use this file except in compliance with the License. You may
    * obtain a copy of the License at
    *
    * http://www.osedu.org/licenses/ECL-2.0
    *
    * Unless required by applicable law or agreed to in writing,
   * software distributed under the License is distributed on an "AS IS"
   * BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
   * or implied. See the License for the specific language governing
   * permissions and limitations under the License.
   */
  package org.kuali.mobility.push.service.rest;
  
  import org.kuali.mobility.push.entity.Device;
  import org.kuali.mobility.push.service.rest.pojo.DeviceResponse;
  import org.kuali.mobility.push.service.rest.pojo.DevicesResponse;
  
  import javax.ws.rs.*;
  import javax.ws.rs.core.MediaType;
  
  /**
   * @author Kuali Mobility Team (mobility.collab@kuali.org)
   */
  @Path("/")
  public interface DeviceServiceRest {
  
      /** Device type constant for Android devices */
      public static final String TYPE_ANDROID 	= "Android";
  
      /** Devices type constant for iOS devices */
      public static final String TYPE_IOS			= "iOS";
  
      /** Device type constant for BlackBerry devices */
      public static final String TYPE_BLACKBERRY 	= "BlackBerry";
  
      /** Device type constraint for Windows devices */
      public static final String TYPE_WINDOWS		= "WindowsMobile";
  
      /**
       * Persists a device and returns the updated device
       * @param device
       */
      @POST
      @Path("/saveDevice")
      @Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
      @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
  	DeviceResponse saveDevice(Device device);
  
      /**
       * Registers a device
       * @param device
       */
      @POST
      @Path("/registerDevice")
      @Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
      @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
  	DeviceResponse registerDevice(Device device);
  
      /**
       *
       * @return
       */
      @GET
      @Path("/devices")
      @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
  	DevicesResponse getDevices();
  
      /**
       * Finds a <code>Device</code> by the Object ID for the <code>Device</code>
       * @param deviceId If of the <code>Device</code> to find.
       * @return
       */
      @GET
      @Path("/findDeviceByDeviceId")
      @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
  	DeviceResponse findDeviceByDeviceId(@QueryParam(value="deviceId") String deviceId);
  
  
  }