net.sf.asterisk.manager.action
Class MailboxStatusAction

java.lang.Object
  net.sf.asterisk.manager.action.AbstractManagerAction
      net.sf.asterisk.manager.action.MailboxStatusAction

All Implemented Interfaces:

java.io.Serializable, ManagerAction

public class MailboxStatusAction
extends AbstractManagerAction

The MailboxStatusAction checks if a mailbox contains waiting messages.
The MailboxStatusAction returns a MailboxStatusResponse.

Version:

$Id: MailboxStatusAction.java,v 1.5 2005/08/07 00:09:42 srt Exp $

Author:

srt

See Also:

MailboxStatusResponse, Serialized Form

Constructor Summary

MailboxStatusAction()
Creates a new empty MailboxStatusAction.

MailboxStatusAction(java.lang.String mailbox)
Creates a new MailboxStatusAction that checks for waiting messages in the given mailbox.

Method Summary

java.lang.String	getAction() Returns the name of this action, i.e.
java.lang.String	getMailbox() Returns the name of the mailbox to query.
void	setMailbox(java.lang.String mailbox) Sets the name of the mailbox to query. This can either be only the name of the mailbox or a string of the form mailboxnumber@context.

Methods inherited from class net.sf.asterisk.manager.action.AbstractManagerAction

getActionId, setActionId, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MailboxStatusAction

public MailboxStatusAction()

Creates a new empty MailboxStatusAction.

MailboxStatusAction

public MailboxStatusAction(java.lang.String mailbox)

Creates a new MailboxStatusAction that checks for waiting messages in the given mailbox.

Parameters:

mailbox - the name of the mailbox to check.
This can either be only the number of the mailbox or a string of the form mailboxnumber@context.If no context is specified "default" is assumed.

Since:

0.2

Method Detail

getAction

public java.lang.String getAction()

Returns the name of this action, i.e. "MailboxStatus".

Specified by:

getAction in interface ManagerAction

Specified by:

getAction in class AbstractManagerAction

getMailbox

public java.lang.String getMailbox()

Returns the name of the mailbox to query.

setMailbox

public void setMailbox(java.lang.String mailbox)

Sets the name of the mailbox to query.
This can either be only the name of the mailbox or a string of the form mailboxnumber@context. If no context is specified "default" is assumed.
Multiple mailboxes may be given, separated by ','. In this case the action checks whether at least one of the given mailboxes has waiting messages.
This property is mandatory.
Example: "1234,1235@mycontext"