Blue Mind
Release 1.0

net.bluemind.core.api
Interface IEntity

All Known Subinterfaces:
IAccessControlledEntity
All Known Implementing Classes:
AccessControlledEntity, CalendarGroup, CalendarInfo, Contact, Device, DeviceUser, DirectoryEntry, DistributionList, DocumentId, Domain, Entity, Event, Folder, Group, Host, Mailshare, Member, Resource, User

public interface IEntity

Base class for Blue Mind objects. This interface holds the properties common to all objects.


Method Summary
 java.util.Map<CustomProperty,java.lang.String> getCustomProperties()
          Returns the CustomProperty values for an entity.
 int getEntityId()
          Returns an installation unique identifier for a Blue Mind object.
 int getId()
          Returns an identifier that is unique among the entities of the same kind.
 java.util.Date getTimeCreate()
          Returns when the IEntity was created.
 java.util.Date getTimeUpdate()
          Returns when the IEntity was last modified, or null if never modified.
 int getUserCreateId()
          Returns the user id (as in Entity.getId()) that created the object.
 java.lang.Integer getUserUpdateId()
          Returns the user id (as in Entity.getId()) that last modified the object, or null if the object was never modified.
 void setCustomProperties(java.util.Map<CustomProperty,java.lang.String> values)
          Sets the values of all the CustomProperty for an entity.
 void setEntityId(int id)
          Sets the installation unique identifier.
 void setId(int id)
          Sets the unique identifier (unique only among entities of the same kind).
 void setTimeCreate(java.util.Date d)
          Sets when the IEntity was created;
 void setTimeUpdate(java.util.Date d)
          Sets when the IEntity was last modified (null is possible if never modified)
 void setUserCreateId(int id)
          Sets the user id (as in Entity.getId()) that created the object.
 void setUserUpdateId(java.lang.Integer id)
          Sets the user id (as in Entity.getId()) that last modified the object, or null if the object was never modified.
 

Method Detail

getId

int getId()
Returns an identifier that is unique among the entities of the same kind. For example Entity.getId() and Entity.getId() can return the same value. For a globally unique identifier, look at getEntityId().

Returns:

setId

void setId(int id)
Sets the unique identifier (unique only among entities of the same kind).

Parameters:
id -

getEntityId

int getEntityId()
Returns an installation unique identifier for a Blue Mind object.

Returns:
The entity id

setEntityId

void setEntityId(int id)
Sets the installation unique identifier.

Parameters:
id -

getTimeUpdate

java.util.Date getTimeUpdate()
Returns when the IEntity was last modified, or null if never modified.

Returns:

setTimeUpdate

void setTimeUpdate(java.util.Date d)
Sets when the IEntity was last modified (null is possible if never modified)

Parameters:
d - The last modification date.

getTimeCreate

java.util.Date getTimeCreate()
Returns when the IEntity was created.

Returns:

setTimeCreate

void setTimeCreate(java.util.Date d)
Sets when the IEntity was created;

Parameters:
d -

getUserCreateId

int getUserCreateId()
Returns the user id (as in Entity.getId()) that created the object.

Returns:
The user id

setUserCreateId

void setUserCreateId(int id)
Sets the user id (as in Entity.getId()) that created the object.


getUserUpdateId

java.lang.Integer getUserUpdateId()
Returns the user id (as in Entity.getId()) that last modified the object, or null if the object was never modified.

Returns:
The user id

setUserUpdateId

void setUserUpdateId(java.lang.Integer id)
Sets the user id (as in Entity.getId()) that last modified the object, or null if the object was never modified.


setCustomProperties

void setCustomProperties(java.util.Map<CustomProperty,java.lang.String> values)
Sets the values of all the CustomProperty for an entity.

Parameters:
values -

getCustomProperties

java.util.Map<CustomProperty,java.lang.String> getCustomProperties()
Returns the CustomProperty values for an entity.

Returns:

Blue Mind
Release 1.0