com.kryshchuk.imcollector.domain.Collectible Maven / Gradle / Ivy

Go to download
/*
 * imcollector Domain
 * Copyright (C) 2013  Yuriy Kryshchuk
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package com.kryshchuk.imcollector.domain;

/**
 * An item that one may collect. The collectible item is typically an identifiable entity which has some name (title).
 *
 * @author yura
 * @since 1.0
 */
public interface Collectible {

  /**
   * Unique collectible identifier. Im simplest case it has a unique value within the collection domain. Ideally it
   * should be globally unique identifier in order to refer the item in other domains.
   *
   * @return unique identifier
   */
  String getId();

  /**
   * The collectible item name. It describes in general exactly this item.
   *
   * @return item name
   */
  String getName();

}