|
Asterisk-Java | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.asteriskjava.manager.action.AbstractManagerAction
org.asteriskjava.manager.action.DbGetAction
public class DbGetAction
Retrieves an entry in the Asterisk database for a given family and key.
If an entry is found a DBGetResponseEvent is sent by Asterisk containing the value, otherwise a ManagerError indicates that no entry matches.
It is implemented in main/db.c.
Available since Asterisk 1.2
DbGetResponseEvent,
Serialized Form| Constructor Summary | |
|---|---|
DbGetAction()
Creates a new empty DbGetAction. |
|
DbGetAction(java.lang.String family,
java.lang.String key)
Creates a new DbGetAction that retrieves the value of the database entry with the given key in the given family. |
|
| Method Summary | |
|---|---|
java.lang.String |
getAction()
Returns the name of the action for example "Hangup". |
java.lang.Class<? extends ResponseEvent> |
getActionCompleteEventClass()
Returns the event type that indicates that Asterisk is finished sending response events for this action. |
java.lang.String |
getFamily()
Returns the family of the key. |
java.lang.String |
getKey()
Returns the the key of the entry to retrieve. |
void |
setFamily(java.lang.String family)
Sets the family of the key. |
void |
setKey(java.lang.String key)
Sets the key of the entry to retrieve. |
| Methods inherited from class org.asteriskjava.manager.action.AbstractManagerAction |
|---|
getActionId, setActionId, toString |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface org.asteriskjava.manager.action.ManagerAction |
|---|
getActionId, setActionId |
| Constructor Detail |
|---|
public DbGetAction()
public DbGetAction(java.lang.String family,
java.lang.String key)
family - the family of the keykey - the key of the entry to retrieve| Method Detail |
|---|
public java.lang.String getAction()
ManagerAction
getAction in interface ManagerActiongetAction in class AbstractManagerActionpublic java.lang.String getFamily()
public void setFamily(java.lang.String family)
family - the family of the key.public java.lang.String getKey()
public void setKey(java.lang.String key)
key - the key of the entry to retrieve.public java.lang.Class<? extends ResponseEvent> getActionCompleteEventClass()
EventGeneratingAction
getActionCompleteEventClass in interface EventGeneratingActionResponseEvent
|
Asterisk-Java | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||