com.uc4.api.objects

Class LocaMessageItem

java.lang.Object

com.uc4.api.objects.LocaMessageItem

public class LocaMessageItem
extends java.lang.Object

This class represents Loca - Object messages.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LocaMessageItem.Language This inner class represents message languages.
static class	LocaMessageItem.LocaMessageType This inner class represents message type.

Constructor Summary

Constructors

Constructor and Description
LocaMessageItem(LocaMessageItem.Language language, java.lang.String msgTxt, java.lang.String msgLongTxt, LocaMessageItem.LocaMessageType typ) Creates a new LocaMessageItem instance.
LocaMessageItem(LocaMessageItem.Language language, java.lang.String ticktNr, java.lang.String msgTxt, java.lang.String msgLongTxt, java.lang.String txtSpkID, LocaMessageItem.LocaMessageType typ) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getMessageId()
java.util.Map<LocaMessageItem.Language,com.uc4.api.objects.LocaMessageItem.LocaMessageText>	getMessageTxtMap() Returns the text-map of this Message item - Object.
java.lang.String	getMsgLongTxt(LocaMessageItem.Language txtMapKey) Returns the long text of an languages.
java.lang.String	getMsgTxt(LocaMessageItem.Language key) Returns the message of an languages.
java.lang.String	getTicktNr() Returns the ticket number.
java.lang.String	getTxtSpkID() Returns the speaking ID of the message.
LocaMessageItem.LocaMessageType	getTyp() Returns the message type.
void	setMessage(LocaMessageItem.Language lng, java.lang.String text, java.lang.String info) Set an message.
void	setMessageId(int messageId) Set Message ID.
void	setMessageInfo(LocaMessageItem.Language lng, java.lang.String message) Set an message info or long text.
void	setMessageText(LocaMessageItem.Language lng, java.lang.String message) Set an message.
void	setTicktNr(java.lang.String ticktNr) Sets the ticket number.
void	setTxtSpkID(java.lang.String txtSpkID) Sets a speaking ID of the message.
void	setTyp(LocaMessageItem.LocaMessageType typ) Set the message type .

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LocaMessageItem

public LocaMessageItem(LocaMessageItem.Language language,
               java.lang.String ticktNr,
               java.lang.String msgTxt,
               java.lang.String msgLongTxt,
               java.lang.String txtSpkID,
               LocaMessageItem.LocaMessageType typ)

Constructor.

Parameters:

language - language of Message

ticktNr - ticktNr TicketNr

msgTxt - shown message

msgLongTxt - message info or longText

txtSpkID - languages ID

typ - typ ot the message

LocaMessageItem

public LocaMessageItem(LocaMessageItem.Language language,
               java.lang.String msgTxt,
               java.lang.String msgLongTxt,
               LocaMessageItem.LocaMessageType typ)

Creates a new LocaMessageItem instance.

Parameters:

language - Langauge

msgTxt - Message text

msgLongTxt - Message long text

typ - Type of the message

Method Detail

getMsgTxt

public java.lang.String getMsgTxt(LocaMessageItem.Language key)

Returns the message of an languages.

Parameters:

key - language

Returns:

messageTxtMap Map of all Messages

getMsgLongTxt

public java.lang.String getMsgLongTxt(LocaMessageItem.Language txtMapKey)

Returns the long text of an languages.

Parameters:

txtMapKey - language

Returns:

long text

getTicktNr

public java.lang.String getTicktNr()

Returns the ticket number.

Returns:

Ticket number

setTicktNr

public void setTicktNr(java.lang.String ticktNr)

Sets the ticket number.

Parameters:

ticktNr - Ticket number

getTxtSpkID

public java.lang.String getTxtSpkID()

Returns the speaking ID of the message.

Returns:

ID

setTxtSpkID

public void setTxtSpkID(java.lang.String txtSpkID)

Sets a speaking ID of the message.

Parameters:

txtSpkID - ID

getTyp

public LocaMessageItem.LocaMessageType getTyp()

Returns the message type.

Returns:

type type

setTyp

public void setTyp(LocaMessageItem.LocaMessageType typ)

Set the message type .

Parameters:

typ - type

getMessageTxtMap

public java.util.Map<LocaMessageItem.Language,com.uc4.api.objects.LocaMessageItem.LocaMessageText> getMessageTxtMap()

Returns the text-map of this Message item - Object.

Returns:

messageTxtMap Message text map

setMessageText

public void setMessageText(LocaMessageItem.Language lng,
                  java.lang.String message)

Set an message.

Parameters:

lng - languages

message - Message text

setMessageInfo

public void setMessageInfo(LocaMessageItem.Language lng,
                  java.lang.String message)

Set an message info or long text.

Parameters:

lng - languages

message - Message info or long text

setMessage

public void setMessage(LocaMessageItem.Language lng,
              java.lang.String text,
              java.lang.String info)

Set an message.

Parameters:

lng - languages

text - Message text

info - Message info or long text

getMessageId

public java.lang.String getMessageId()

Returns:

the messageIdMsg

setMessageId

public void setMessageId(int messageId)

Set Message ID.

Parameters:

messageId - the messageIdMsg to set