org.asteriskjava.manager.action

Class SetCdrUserFieldAction

java.lang.Object

org.asteriskjava.manager.action.AbstractManagerAction

org.asteriskjava.manager.action.SetCdrUserFieldAction

All Implemented Interfaces:

Serializable, ManagerAction

public class SetCdrUserFieldAction
extends AbstractManagerAction

The SetCDRUserFieldAction causes the user field of the call detail record for the given channel to be changed.

Depending on the value of the append property the value is appended or overwritten.

The SetCDRUserFieldAction is implemented in apps/app_setcdruserfield.c

Version:

$Id$

Author:

srt

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SetCdrUserFieldAction() Creates a new empty SetCdrUserFieldAction.
SetCdrUserFieldAction(String channel, String userField) Creates a new SetCdrUserFieldAction that sets the user field of the call detail record for the given channel to the given value.
SetCdrUserFieldAction(String channel, String userField, Boolean append) Creates a new SetCDRUserFieldAction that sets the user field of the call detail record for the given channel to the given value.

Method Summary

Modifier and Type	Method and Description
String	getAction() Returns the name of the action, i.e.
Boolean	getAppend() Returns if the value of the cdr user field is appended or overwritten.
String	getChannel() Returns the name of the channel to set the cdr user field on.
String	getUserField() Returns the value of the cdr user field to set or append.
void	setAppend(Boolean append) Set to true to append the value to the cdr user field or false to overwrite.
void	setChannel(String channel) Sets the name of the channel to set the cdr user field on.
void	setUserField(String userField) Sets the value of the cdr user field to set or append.

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

Constructor Detail

SetCdrUserFieldAction

public SetCdrUserFieldAction()

Creates a new empty SetCdrUserFieldAction.

SetCdrUserFieldAction

public SetCdrUserFieldAction(String channel,
                             String userField)

Creates a new SetCdrUserFieldAction that sets the user field of the call detail record for the given channel to the given value.

Parameters:

channel - the name of the channel

userField - the new value of the userfield

Since:

0.2

SetCdrUserFieldAction

public SetCdrUserFieldAction(String channel,
                             String userField,
                             Boolean append)

Creates a new SetCDRUserFieldAction that sets the user field of the call detail record for the given channel to the given value.

Parameters:

channel - the name of the channel

userField - the new value of the userfield

append - true to append the value to the cdr user field or false to overwrite

Since:

0.2

Method Detail

getAction

public String getAction()

Returns the name of the action, i.e. "SetCDRUserField".

Specified by:

getAction in interface ManagerAction

Specified by:

getAction in class AbstractManagerAction

getChannel

public String getChannel()

Returns the name of the channel to set the cdr user field on.

setChannel

public void setChannel(String channel)

Sets the name of the channel to set the cdr user field on.

This property is mandatory.

getUserField

public String getUserField()

Returns the value of the cdr user field to set or append.

setUserField

public void setUserField(String userField)

Sets the value of the cdr user field to set or append.

This property is mandatory.

getAppend

public Boolean getAppend()

Returns if the value of the cdr user field is appended or overwritten.

setAppend

public void setAppend(Boolean append)

Set to true to append the value to the cdr user field or false to overwrite.