DataAction Object

add_field()

allows to register field for usage while INSERT/UPDATE/DELETE operation.

<cfset action.add_field(name,value)>

Parameters:

name - name or alias of the field
value - value of the field in question

See also:

remove_field

error()

marks provided data as invalid and cancels default UPDATE processing (invalid record will be highlighted in red bold font).

<cfset action.error()>

Parameters:

none

See Also:

invalid

get_data()

returns hash of data values that will take part in INSERT/UPDATE/DELETE operations.

<cfset action.get_data()>

Parameters:

none.

get_id()

returns id of the currently selected record.

<cfset action.get_id()>

Parameters:

none.

get_new_id()

returns ID, received after INSERT operation (valid for afterProcessing event only).

<cfset action.get_new_id()>

Parameters:

none.

get_status()

returns action type of the item.

<cfset action.get_status()>

Returns:

update, insert, delete, error or custom status set through set_status() method Parameters:
none.

See Also:

set_status

get_value()

returns value of a field.

<cfset action.get_value(name)>

Parameters:

name - name of column or alias.

See Also:

set_value

invalid()

marks provided data as invalid and cancels default UPDATE processing (invalid record will be highlighted in bold font).

<cfset action.invalid()>

Parameters:

none.

See Also:

error

remove_field()

allows to remove one of default fields from INSERT/UPDATE/DELETE operation.

<cfset action.remove_field(name,value)>

Parameters:

name - name or alias of the field.
value - value of the field in question.

See Also:

add_field

set_response_attribute()

Allows to define custom attribute which will be added to the related action tag in XML response.

<cfset action.set_response_attribute(name,value)>

Parameters:

name - name of the attribute.
value - value of the attribute in question.

See Also:

set_response_text()

Allows to set string that will be included in response

<cfset action.set_response_text(text)>

Parameters:

text - any text value that will be returned on client-side with related action.

See Also:

set_response_xml()

Allows to set xml-string that will be included in response (if you need to provide just a text - use set_response_text() method).

<cfset action.set_response_xml(text)>

Parameters:

text - any text value that will be returned on client-side with related action.

See Also:

set_status()

sets the status of operation.

<cfset action.set_status(value)>

Parameters:

value - status of operation.

It can be either some predefined value (updated, inserted, deleted, error) or any custom status. Beware, when you set custom status you cancel default data processing.

See Also:

get_status

set_value()

sets value of a field.

<cfset action.set_value(name,value)>

Parameters:

name - name or alias of the field
value - value of the field in question

See Also:

get_value

success()

confirms that operation has been executed correctly and cancels any default data processing.

<cfset action.success()>

Parameters:

in case INSERT operation: a new ID of element ( which will be updated on client-side )