converge.service
Class Message

java.lang.Object
  |
  +--converge.service.Message
All Implemented Interfaces:
XMLContentInterface

public class Message
extends java.lang.Object
implements XMLContentInterface

Message sisältää viestin järjestelmän sisäisessä muodossa.


Constructor Summary
Message(User user)
          Luo uuden tyhjän Message-olion.
Message(User user, org.w3c.dom.Document doc)
          Luo uuden Message-olion annetusta XML-dokumentista.
 
Method Summary
 void addAttachment(Attachment attachment)
          Lisää viestiin uuden liitetiedoston.
 void addAttribute(ContextModelValueAttribute cmAttr)
          ContextModelValueAttribuuttien viestiolioon lisäämiseen tarkoitettu metodi,
 void createXML(org.w3c.dom.Node parent)
          Muodostaa Message-oliosta XML-elementin.
 Attachment[] getAttachmentList()
          Palauttaa listan viestiin liitetyistä liitetiedostoista
 MessageAttributeInterface getMessageAttribute(java.lang.String name)
          Palauttaa halutun viestiattribuutin.
 java.lang.String getMessageID()
          Palauttaa Messagen yksikäsitteisen viestin tunnuksen
 User getUser()
          Palauttaa Message-olioon liitetyn User-olion.
 boolean loadXML(org.w3c.dom.Node myContent)
          Muodostaa annetusta XML-elementistä Message-olion.
static void main(java.lang.String[] args)
           
 void setMessageAttribute(java.lang.String name, java.lang.Object value, boolean permanent)
          Liitetään viestiolioon uusi MessageAttributeInterface:n toteuttava attribuutti,
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Message

public Message(User user,
               org.w3c.dom.Document doc)
Luo uuden Message-olion annetusta XML-dokumentista.

Parameters:
user - käyttäjäolio
doc - XML-dokumentti

Message

public Message(User user)
Luo uuden tyhjän Message-olion.

Parameters:
user - käyttäjäolio
Method Detail

getUser

public User getUser()
Palauttaa Message-olioon liitetyn User-olion.

Returns:
User-olio

getMessageID

public java.lang.String getMessageID()
Palauttaa Messagen yksikäsitteisen viestin tunnuksen

Returns:
viestin tunnus

getMessageAttribute

public MessageAttributeInterface getMessageAttribute(java.lang.String name)
Palauttaa halutun viestiattribuutin.

Parameters:
name - viestiattribuutin nimi
Returns:
viestiattribuutti tai null

setMessageAttribute

public void setMessageAttribute(java.lang.String name,
                                java.lang.Object value,
                                boolean permanent)
Liitetään viestiolioon uusi MessageAttributeInterface:n toteuttava attribuutti,

Parameters:
name - Attribuutti-ilmentymälle annettava nimi, joka on jokin loogisen attribuutin nimi esim. Subject
value - Attribuutti-ilmentymälle annettava arvotietosisältö
permanent - Onko attribuutti-ilmentymä viestiin liitettävä fakta eli tallennetaanko tieto kantaan

addAttribute

public void addAttribute(ContextModelValueAttribute cmAttr)
ContextModelValueAttribuuttien viestiolioon lisäämiseen tarkoitettu metodi,

Parameters:
cmAttr - Parametri, joka lisätään viestiolion ei kantaan talletettavana attribuuttina

getAttachmentList

public Attachment[] getAttachmentList()
Palauttaa listan viestiin liitetyistä liitetiedostoista

Returns:
Attachment-taulukko liitetiedostoista

addAttachment

public void addAttachment(Attachment attachment)
Lisää viestiin uuden liitetiedoston.

Parameters:
attachment - uusi liitetiedosto (Attachment-olio)

createXML

public void createXML(org.w3c.dom.Node parent)
Muodostaa Message-oliosta XML-elementin.

Specified by:
createXML in interface XMLContentInterface
Parameters:
parent - XML-dokumentin node, jonka lapsielementiksi olion tiedot kirjoitetaan

loadXML

public boolean loadXML(org.w3c.dom.Node myContent)
Muodostaa annetusta XML-elementistä Message-olion.

Specified by:
loadXML in interface XMLContentInterface
Parameters:
myContent - XML-dokumentti, jonka sisällöstä muodostetaan olion tiedot
Returns:
true jos tietojen lataus onnistui
See Also:
XMLContentInterface.createXML( Node )

main

public static void main(java.lang.String[] args)