com.uc4.api.objects

Class LocaMessages

java.lang.Object

com.uc4.api.objects.LocaMessages

public class LocaMessages
extends java.lang.Object

This class represents Loca - Object messages.

Method Summary

Modifier and Type	Method and Description
void	addLocaMessageItem(LocaMessageItem messageItem) Put a new instance of an messageItem into the message item map and choose the next free message number from the given interval.
LocaMessageItem	getLocaMessage(java.lang.String messsageId) Get a LocaMessageItem with an given MessageNummber.
int	getMessageCount() Returns the size of message hashmap of this Loca - Object.
java.util.Iterator<java.lang.String>	messageListIterator() Returns an java.util.Iterator of set parameter names.
void	removeAllLocaMessages() Removes all LOCA-Messages.
void	removeLocaMessage(java.lang.String messsageId) Remove the messageItem from the HashMap.
void	removeLocaMessages(java.lang.String[] messageIds) Remove a list of LOCA-Messages.

Methods inherited from class java.lang.Object

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

Method Detail

getMessageCount

public int getMessageCount()

Returns the size of message hashmap of this Loca - Object. Each count is one messageItem how contains all languages.

Returns:

the messageCount

getLocaMessage

public LocaMessageItem getLocaMessage(java.lang.String messsageId)

Get a LocaMessageItem with an given MessageNummber.

Parameters:

messsageId - the id of an messageItem who contains all languges.

Returns:

the LocaMessageItem

removeLocaMessage

public void removeLocaMessage(java.lang.String messsageId)

Remove the messageItem from the HashMap.

Parameters:

messsageId - messageId

removeLocaMessages

public void removeLocaMessages(java.lang.String[] messageIds)

Remove a list of LOCA-Messages.

Parameters:

messageIds - LOCA-MessagesID that should deleted

removeAllLocaMessages

public void removeAllLocaMessages()

Removes all LOCA-Messages.

messageListIterator

public java.util.Iterator<java.lang.String> messageListIterator()

Returns an java.util.Iterator of set parameter names. Each parameter is stored as java.lang.String.

Returns:

Iterator Names of set message map.

addLocaMessageItem

public void addLocaMessageItem(LocaMessageItem messageItem)

Put a new instance of an messageItem into the message item map and choose the next free message number from the given interval.

Parameters:

messageItem - messageItem