Package com.caplin.datasource.messaging
Interface Message
-
- All Known Subinterfaces:
ContainerMessage
,GenericMessage
,MappingMessage
,NewsMessage
,PageMessage
,PermissionMessage
,RecordMessage
,RecordType1Message
,RecordType2Message
,RecordType3Message
,StoryMessage
,WrapperMessage
public interface Message
A
Message
represents a DataSource message containing an update to an existing subject or a complete image of it.Message
is the base interface for all messages generated by DataSource regardless of the message type. Therefore the base interface provides no functionality for altering the content of the message and one of the following derived interfaces should be used to add data to aMessage
:RecordType1Message
RecordType2Message
RecordType3Message
GenericMessage
ContainerMessage
PermissionMessage
NewsMessage
StoryMessage
PageMessage
You do not have to implement this interface yourself. Implementations of
Message
can be created by calling the relevant creation method onMessageFactory
; for example,MessageFactory.createRecordType1Message(String)
orMessageFactory.createContainerMessage(String)
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description MessageType
getMessageType()
Gets the type for this message.java.lang.String
getSubject()
Gets the subject of this message.boolean
isImage()
Gets a boolean value indicating whether thisMessage
represents an image or an update.void
setImage(boolean image)
Sets a boolean value indicating whether thisMessage
represents an image of the data or an update to it.
-
-
-
Method Detail
-
isImage
boolean isImage()
Gets a boolean value indicating whether thisMessage
represents an image or an update. By default, this method returnsfalse
indicating that theMessage
is an update and not an image. To change a message to be an image, callsetImage(boolean)
passing in the valuetrue
.- Returns:
true
if this message is an image of the object,false
if it is an update to the existing state of the object.
-
setImage
void setImage(boolean image)
Sets a boolean value indicating whether thisMessage
represents an image of the data or an update to it. By default, a newly createdMessage
is deemed to be an update and not an image.- Parameters:
image
- When set totrue
, the receiver will clear all previous data for that subject before adding the sent data. When set tofalse
, the receiver adds the sent data to previous data sent to that subject.
-
getSubject
java.lang.String getSubject()
Gets the subject of this message.- Returns:
- The subject.
-
getMessageType
MessageType getMessageType()
Gets the type for this message.- Returns:
- The MessageType for this message
-
-