Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.base
Class EntityDescriptor

java.lang.Object
  extended by com.jivesoftware.base.EntityDescriptor

public class EntityDescriptor
extends java.lang.Object

An object that describes a specific entity. An entity is an object of the system, such as a user, group, kb document, forum, thread, etc.

This class simply holds information about the entity which includes its ID and type. The type of an entity is an int constant from the JiveConstants class.

Note, there is no reference to the actual object this entity describes. This merely holds the most basic information about the object. Given the ID and type the actual object can be loaded from the system (typically from a Manager or Factory class).


Constructor Summary
EntityDescriptor(long id, int type)
          Creates a new descripter given an ID and type.
 
Method Summary
 long getId()
          Returns the ID of this entity (object).
 long getID()
           
 int getType()
          Returns the type of object this is.
 boolean isValid()
          Returns true if this entity descriptor references a valid object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EntityDescriptor

public EntityDescriptor(long id,
                        int type)
Creates a new descripter given an ID and type.

Parameters:
id - the ID of the entity (or object).
type - the type of entity (or object) this is. This will be a constant from the JiveConstants class.
Method Detail

getId

public long getId()
Returns the ID of this entity (object).

Returns:
the ID of this entity.

getID

public long getID()

getType

public int getType()
Returns the type of object this is. This will be an int constant from the JiveConstants class.

Returns:
the type of object this is. This will be a constant from JiveConstants.

isValid

public boolean isValid()
Returns true if this entity descriptor references a valid object. False otherwise.

Returns:
true if this entity descriptor references a valid object. False otherwise.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.