/*
   Copyright 2010 James Pether Sörling Licensed under the Apache 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.apache.org/licenses/LICENSE-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. 
   	$Id
   */
   package org.directdemocracyportal.democracy.model.core;
   
   import java.util.HashSet;
   import java.util.Set;
   
  import javax.persistence.Entity;
  import javax.persistence.FetchType;
  import javax.persistence.GeneratedValue;
  import javax.persistence.GenerationType;
  import javax.persistence.Id;
  import javax.persistence.Inheritance;
  import javax.persistence.InheritanceType;
  import javax.persistence.JoinColumn;
  import javax.persistence.ManyToMany;
  import javax.persistence.ManyToOne;
  
  import org.hibernate.annotations.Cache;
  import org.hibernate.annotations.CacheConcurrencyStrategy;
  
  /***
   * The Class Role.
   */
  @Entity
  @Inheritance(strategy = InheritanceType.JOINED)
  @Cache(usage = CacheConcurrencyStrategy.NONSTRICT_READ_WRITE)
  public class Role extends BaseEntity
  {
  
      /*** The Constant serialVersionUID. */
      private static final long serialVersionUID = 3342667773031897040L;
  
      /*** The id. */
      private Long id;
  
      /*** The name. */
      private String name;
  
      /*** The short description. */
      private String shortDescription;
  
      /*** The long description. */
      private String longDescription;
  
      /*** The group agent. */
      private GroupAgent groupAgent;
  
      /*** The players. */
      private Set<Agent> players = new HashSet<Agent>();
  
      /***
       * Instantiates a new role.
       */
      public Role() {
      }
  
      /*
       * (non-Javadoc)
       *
       * @see org.directdemocracyportal.democracy.model.core.BaseEntity#getId()
       */
      @Override
      @Id
      @GeneratedValue(strategy = GenerationType.AUTO)
      public Long getId() {
          return this.id;
      }
  
      /***
       * Sets the id.
       *
       * @param id the new id
       */
      public void setId(Long id) {
          this.id = id;
      }
  
      /***
       * Gets the name.
       *
       * @return the name
       */
      public String getName() {
          return name;
      }
  
      /***
       * Sets the name.
       *
       * @param name the new name
       */
      public void setName(String name) {
          this.name = name;
      }
  
      /***
      * Gets the group agent.
      *
      * @return the group agent
      */
     @ManyToOne
     @JoinColumn
     public GroupAgent getGroupAgent() {
         return this.groupAgent;
     }
 
     /***
      * Sets the group agent.
      *
      * @param organisation the new group agent
      */
     public void setGroupAgent(GroupAgent organisation) {
         this.groupAgent = organisation;
     }
 
     /***
      * Gets the players.
      *
      * @return the players
      */
     @ManyToMany(fetch = FetchType.LAZY)
     public Set<Agent> getPlayers() {
         return players;
     }
 
     /***
      * Sets the players.
      *
      * @param players the new players
      */
     public void setPlayers(Set<Agent> players) {
         this.players = players;
     }
 
     /***
      * Gets the short description.
      *
      * @return the short description
      */
     public String getShortDescription() {
         return shortDescription;
     }
 
     /***
      * Sets the short description.
      *
      * @param shortDescription the new short description
      */
     public void setShortDescription(String shortDescription) {
         this.shortDescription = shortDescription;
     }
 
     /***
      * Gets the long description.
      *
      * @return the long description
      */
     public String getLongDescription() {
         return longDescription;
     }
 
     /***
      * Sets the long description.
      *
      * @param longDescription the new long description
      */
     public void setLongDescription(String longDescription) {
         this.longDescription = longDescription;
     }
 
     /*
      * (non-Javadoc)
      *
      * @see java.lang.Object#hashCode()
      */
     @Override
     public int hashCode() {
         final int prime = 31;
         int result = 1;
         result = prime * result + ((id == null) ? 0 : id.hashCode());
         result = prime * result
                 + ((longDescription == null) ? 0 : longDescription.hashCode());
         result = prime * result + ((name == null) ? 0 : name.hashCode());
         result = prime
                 * result
                 + ((shortDescription == null) ? 0 : shortDescription.hashCode());
         return result;
     }
 
     /*
      * (non-Javadoc)
      *
      * @see java.lang.Object#equals(java.lang.Object)
      */
     @Override
     public boolean equals(Object obj) {
         if (this == obj)
             return true;
         if (obj == null)
             return false;
         if (getClass() != obj.getClass())
             return false;
         final Role other = (Role) obj;
         if (id == null) {
             if (other.id != null)
                 return false;
         } else if (!id.equals(other.id))
             return false;
         if (longDescription == null) {
             if (other.longDescription != null)
                 return false;
         } else if (!longDescription.equals(other.longDescription))
             return false;
         if (name == null) {
             if (other.name != null)
                 return false;
         } else if (!name.equals(other.name))
             return false;
         if (shortDescription == null) {
             if (other.shortDescription != null)
                 return false;
         } else if (!shortDescription.equals(other.shortDescription))
             return false;
         return true;
     }
 }