All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class icc.db.Entity 

java.lang.Object
   |
   +----icc.db.Entity
public abstract class Entity
extends Object
implements Serializable
The Entity class represents the commonalities between projects, partners and documents as data entities in the project database. These commonalities are an identifier and a name.

The identifier, a positive integer, must be unique for each project, partner (and team) or document and is assigned by the database. The number zero is reserved for new entities, before these are submitted to the database and assigned a definitive identifier.
The functionality of the name is dependent on the entity type.

An entity can be trusted or not. Trusted means that the entity reflects correctly on the data in the database at the moment it was created. A trusted entity cannot be altered.

See Also:
Project, Partner, Header

Variable Index

o NEW
The reserved identifier for new entities, before these are submitted to the project database.

Constructor Index

o Entity(Integer, String)

Method Index

o description()
Returns a description for this entity.
o equals(Object)
Compares this object to the specified object.
o getId()
Returns the identifier of this entity.
o getName()
Returns the name of this entity.
o id()
Returns the identifier of this entity.
o isTrusted()
Checks if this is a trusted entity.
o lock()
o name()
Returns the name of this entity.
o setId(Integer)
o setName(String)

Variables

o NEW 
 public static final Integer NEW
The reserved identifier for new entities, before these are submitted to the project database.

Constructors

o Entity 
 Entity(Integer id,
        String name)

Methods

o id 
 public Integer id()
Returns the identifier of this entity.

Returns:
an integral identifier
o getId 
 public Integer getId()
Returns the identifier of this entity. This method is accessible from JavaScript.

Returns:
an integral identifier
o name 
 public String name()
Returns the name of this entity.

Returns:
a string
o getName 
 public String getName()
Returns the name of this entity. This method is accessible from JavaScript.

Returns:
a string
o description 
 public abstract String description()
Returns a description for this entity.

Returns:
a string
o isTrusted 
 public boolean isTrusted()
Checks if this is a trusted entity.

Returns:
true if this entity is trusted, false otherwise
o lock 
 void lock()
o setId 
 void setId(Integer id)
o setName 
 void setName(String name)
o equals 
 public boolean equals(Object obj)
Compares this object to the specified object. The result is true if and only if the argument is not null and is an object of the same class that has the same identifier as this object.

Parameters:
obj - the object to compare with
Returns:
true if the objects are the same; false otherwise
Overrides:
equals in class Object 
All Packages  Class Hierarchy  This Package  Previous  Next  Index

This website has been archived and is no longer maintained.