/**
    * Copyright 2005-2015 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.opensource.org/licenses/ecl2.php
    *
   * 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.rice.ken.bo;
  
  import org.kuali.rice.ken.api.notification.UserChannelSubscription;
  import org.kuali.rice.ken.api.notification.UserChannelSubscriptionContract;
  import org.kuali.rice.krad.bo.PersistableBusinessObjectBase;
  import org.kuali.rice.krad.data.jpa.PortableSequenceGenerator;
  
  import javax.persistence.CascadeType;
  import javax.persistence.Column;
  import javax.persistence.Entity;
  import javax.persistence.FetchType;
  import javax.persistence.GeneratedValue;
  import javax.persistence.Id;
  import javax.persistence.JoinColumn;
  import javax.persistence.OneToOne;
  import javax.persistence.Table;
  
  /**
   * This class represents an instance of a user's subscription to a specific 
   * notification channel.
   * @author Kuali Rice Team (rice.collab@kuali.org)
   */
  @Entity
  @Table(name="KREN_CHNL_SUBSCRP_T")
  public class UserChannelSubscriptionBo extends PersistableBusinessObjectBase implements UserChannelSubscriptionContract {
      @Id
      @GeneratedValue(generator="KREN_CHNL_SUBSCRP_S")
      @PortableSequenceGenerator(name="KREN_CHNL_SUBSCRP_S")
  	@Column(name="CHNL_SUBSCRP_ID")
  	private Long id;
      @Column(name="PRNCPL_ID", nullable=false)
  	private String userId;
      
      @OneToOne(fetch=FetchType.EAGER, cascade={CascadeType.REFRESH, CascadeType.MERGE})
  	@JoinColumn(name="CHNL_ID")
  	private NotificationChannelBo channel;
      
      /**
       * Constructs a UserChannelSubscription instance.
       */
      public UserChannelSubscriptionBo() {
      }
  
      /**
       * Gets the channel attribute. 
       * @return Returns the channel.
       */
      public NotificationChannelBo getChannel() {
  	    return channel;
      }
  
      /**
       * Sets the channel attribute value.
       * @param channel The channel to set.
       */
      public void setChannel(NotificationChannelBo channel) {
  	    this.channel = channel;
      }
  
      /**
       * Gets the id attribute. 
       * @return Returns the id.
       */
      public Long getId() {
  	    return id;
      }
  
      /**
       * Sets the id attribute value.
       * @param id The id to set.
       */
      public void setId(Long id) {
  	    this.id = id;
      }
  
      /**
       * Gets the userId attribute. 
       * @return Returns the userId.
       */
      public String getUserId() {
  	    return userId;
      }
  
      /**
      * Sets the userId attribute value.
      * @param userId The userId to set.
      */
     public void setUserId(String userId) {
 	    this.userId = userId;
     }
 
     /**
      * Converts a mutable bo to its immutable counterpart
      * @param bo the mutable business object
      * @return the immutable object
      */
     public static UserChannelSubscription to(UserChannelSubscriptionBo bo) {
         if (bo == null) {
             return null;
         }
 
         return UserChannelSubscription.Builder.create(bo).build();
     }
 
     /**
      * Converts a immutable object to its mutable counterpart
      * @param im immutable object
      * @return the mutable bo
      */
     public static UserChannelSubscriptionBo from(UserChannelSubscription im) {
         if (im == null) {
             return null;
         }
 
         UserChannelSubscriptionBo bo = new UserChannelSubscriptionBo();
         bo.setId(im.getId());
         bo.setVersionNumber(im.getVersionNumber());
         bo.setObjectId(im.getObjectId());
 
         bo.setUserId(im.getUserId());
         bo.setChannel(im.getChannel() == null ? null : NotificationChannelBo.from(im.getChannel()));
         
         return bo;
     }
 }