Entity.java 1.12 KB
Newer Older
Matt Tucker's avatar
Matt Tucker committed
1 2 3 4 5
/**
 * $RCSfile$
 * $Revision$
 * $Date$
 *
Matt Tucker's avatar
Matt Tucker committed
6
 * Copyright (C) 2004 Jive Software. All rights reserved.
Matt Tucker's avatar
Matt Tucker committed
7
 *
Matt Tucker's avatar
Matt Tucker committed
8 9
 * This software is published under the terms of the GNU Public License (GPL),
 * a copy of which is included in this distribution.
Matt Tucker's avatar
Matt Tucker committed
10
 */
Matt Tucker's avatar
Matt Tucker committed
11

Matt Tucker's avatar
Matt Tucker committed
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
package org.jivesoftware.messenger;

/**
 * <p>A generic entity on the system identified by a unique ID and username.</p>
 * <p/>
 * <p>Entities include Chatbots and Users and can reserve messenger 'entity
 * resources' such as groups, permissions, private storage, etc. From an
 * API standpoint, the Entity provides a common base interface for these
 * items when being sent and returned from generic resource services.</p>
 *
 * @author Iain Shigeoka
 */
public interface Entity {
    /**
     * <p>Returns the entity's id.</p>
     * <p/>
     * <p>All ids must be unique in the system across all Chatbots and Users.</p>
     *
     * @return the entity's id.
     */
    long getID();

    /**
     * <p>Returns the entity's username.</p>
     * <p/>
     * <p>All usernames must be unique in the system.</p>
     *
     * @return the username of the entity.
     */
    String getUsername();
}