|
2.17.2: 2011-06-17 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.basedb.core.data.BasicData net.sf.basedb.core.data.MessageData
public class MessageData
This class holds information about messages.
Message
,
Data API - Other classesField Summary | |
---|---|
private String |
description
|
private String |
from
|
private int |
fromId
|
private boolean |
isRead
|
private JobData |
job
|
static int |
MAX_FROM_LENGTH
The maximum length of the from property. |
private String |
name
|
private boolean |
removed
|
private Date |
timeSent
|
private UserData |
to
|
Fields inherited from interface net.sf.basedb.core.data.NameableData |
---|
MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH |
Constructor Summary | |
---|---|
MessageData()
|
Method Summary | |
---|---|
String |
getDescription()
Get the description for the item. |
String |
getFrom()
The name of the user this message is from. |
int |
getFromId()
The id of the user if this message was from a real user. |
JobData |
getJob()
If this message is a message about a job completion (or failure) this property contains a reference to that job. |
String |
getName()
Get the name of the item. |
Date |
getTimeSent()
Get the date and time this message was sent. |
UserData |
getTo()
The user this message is to. |
boolean |
isRead()
Check if the message has been read or not. |
boolean |
isRemoved()
Check if the removed flag is set for this item. |
void |
setDescription(String description)
Set the description for the item. |
void |
setFrom(String from)
|
void |
setFromId(int fromId)
|
void |
setJob(JobData job)
|
void |
setName(String name)
Set the name of the item. |
void |
setRead(boolean isRead)
|
void |
setRemoved(boolean removed)
Set the removed flag for this item. |
void |
setTimeSent(Date timeSent)
|
void |
setTo(UserData to)
|
Methods inherited from class net.sf.basedb.core.data.BasicData |
---|
equals, getId, getVersion, hashCode, setId, setVersion, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface net.sf.basedb.core.data.IdentifiableData |
---|
getId, getVersion |
Field Detail |
---|
private String name
private String description
private boolean removed
private UserData to
public static final int MAX_FROM_LENGTH
getFrom()
,
Constant Field Valuesprivate String from
private int fromId
private Date timeSent
private JobData job
private boolean isRead
Constructor Detail |
---|
public MessageData()
Method Detail |
---|
public String getName()
NameableData
getName
in interface NameableData
String
with the name of the itempublic void setName(String name)
NameableData
MAX_NAME_LENGTH
constant.
setName
in interface NameableData
name
- The new name for the itempublic String getDescription()
NameableData
getDescription
in interface NameableData
String
with a description of the itempublic void setDescription(String description)
NameableData
MAX_DESCRIPTION_LENGTH
constant.
setDescription
in interface NameableData
description
- The new description for the itempublic boolean isRemoved()
RemovableData
isRemoved
in interface RemovableData
public void setRemoved(boolean removed)
RemovableData
setRemoved
in interface RemovableData
removed
- TRUE if the item should be flagged as removed,
FALSE otherwisepublic UserData getTo()
public void setTo(UserData to)
public String getFrom()
public void setFrom(String from)
public int getFromId()
public void setFromId(int fromId)
public Date getTimeSent()
public void setTimeSent(Date timeSent)
public JobData getJob()
public void setJob(JobData job)
public boolean isRead()
public void setRead(boolean isRead)
|
2.17.2: 2011-06-17 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |