portlets.compoze.im.tags
Class Result

java.lang.Object

  |

  +--portlets.compoze.im.tags.Result

All Implemented Interfaces:

java.io.Serializable

public class Result

extends java.lang.Object

implements java.io.Serializable

This class represents a result after executing a command.

See Also:

Serialized Form

Constructor Summary

Result(java.lang.String sResultCode)
Constructor.

Method Summary

java.lang.String[][]	getNvpairs() Gets the name/value pairs.
void	putError(java.lang.Throwable e) Puts the error in the result.
void	putMessage(java.lang.String sSessionID, IInstantMessage im, int idx, java.lang.String sImageUri, java.util.Locale locale) Puts the message in the result.
void	putParam(java.lang.String sParam, int iValue) Puts the param in the result.
void	putParam(java.lang.String sParam, int iIndex, int iValue) Puts the param in the result.
void	putParam(java.lang.String sParam, int iIndex, java.lang.String sValue) Puts the param in the result.
void	putParam(java.lang.String sParam, java.lang.String sValue) Puts the param in the result.
void	putPresence(IFriend f) Puts the presence in the result for the specified friend.
void	putPresence(IFriend f, int idx) Puts the presence in the result for the specified friend.
void	putTyping(ImEvent fe, int idx) Puts the typing in the result for the specified friend event.
void	setResultCode(java.lang.String sResultCode) Sets the result code.

Methods inherited from class java.lang.Object

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

Constructor Detail

Result

public Result(java.lang.String sResultCode)

Constructor.

Parameters:

sResultCode - the result code

Method Detail

putParam

public void putParam(java.lang.String sParam,
                     int iValue)

Puts the param in the result. The param is overwritten if it already exists.

Parameters:

sParam - the param

iValue - the value

putParam

public void putParam(java.lang.String sParam,
                     int iIndex,
                     int iValue)

Puts the param in the result. The param is overwritten if it already exists.

Parameters:

sParam - the param

iIndex - the param index

iValue - the value

putParam

public void putParam(java.lang.String sParam,
                     int iIndex,
                     java.lang.String sValue)

Puts the param in the result. The param is overwritten if it already exists.

Parameters:

sParam - the param

iIndex - the param index

sValue - the value

putParam

public void putParam(java.lang.String sParam,
                     java.lang.String sValue)

Puts the param in the result. The param is overwritten if it already exists.

Parameters:

sParam - the param

sValue - the value

setResultCode

public void setResultCode(java.lang.String sResultCode)

Sets the result code.

Parameters:

sResultCode - the result code

getNvpairs

public java.lang.String[][] getNvpairs()

Gets the name/value pairs.

Returns:

the name/value pairs

putError

public void putError(java.lang.Throwable e)

Puts the error in the result.

Parameters:

e - the error

putPresence

public void putPresence(IFriend f)
                 throws CollaborationException

Puts the presence in the result for the specified friend.

Parameters:

f - the friend

putPresence

public void putPresence(IFriend f,
                        int idx)
                 throws CollaborationException

Puts the presence in the result for the specified friend.

Parameters:

f - the friend

idx - the friend index

putMessage

public void putMessage(java.lang.String sSessionID,
                       IInstantMessage im,
                       int idx,
                       java.lang.String sImageUri,
                       java.util.Locale locale)
                throws CollaborationException

Puts the message in the result.

Parameters:

sSessionID - the session ID

im - the message

idx - the index

iImageWidth - the image width (in pixels)

iImageHeight - the image height (in pixels)

putTyping

public void putTyping(ImEvent fe,
                      int idx)
               throws CollaborationException

Puts the typing in the result for the specified friend event.

Parameters:

fe - the friend event

idx - the friend event index