SaveWithCustomData method: WorklistEntry class

Syntax

SaveWithCustomData(&Message, &FieldNameArray, &FieldValueArray)

Description

Use the SaveWithCustomData method to save the worklist entry to the database, as well as to pass additional data back to the requestor that created this worklist entry. You should only use this method with worklist entries that are created by web service. If you want to save a worklist entry without additional data, or a worklist entry that was not created using a web service, use the Save method instead.

If the worklist entry was not created by a web service, or if the worklist entry is not marked as worked (that is, if the inststatus property is not set to 2,) the additional data is ignored.

Parameters

Parameter Description

&Message

Specify an already instantiated and populated response message containing the custom data to be sent back to the originating web service.

&FieldNameArray

Specify an already instantiated and populated array of string containing the field names to be used by the web service that created the worklist entry.

&FieldValueArray

Specify an already instantiated and populated array of string containing matching field values to be used by the web service that created the worklist entry.

Returns

A message object containing the final message that was sent to the web service if successful, a null object otherwise.

PeopleCode Event Considerations

You must include this method within events that allow database updates. This includes the following PeopleCode events:

  • SavePreChange (Page)

  • SavePostChange (Page)

  • Workflow

  • Message Subscription (the Integration Broker INotificationHandler interface)

  • FieldChange

If this method results in a failure, all database updates are rolled back. All information the user entered into the component is lost, as if the user pressed ESC.

Related Topics