lockProvisional (NotesForm - JavaScript™)

Locks a form provisionally.

Defined in

NotesForm

Syntax

lockProvisional() : boolean

lockProvisional(name:string) : boolean

lockProvisional(names:any) : boolean

Parameter Description
String name java.util.Vector names The names of the lock holders. Each lock holder must be a user or group. Defaults to one lock holder: the effective user. The empty string ("") is not permitted.
Return value Description
boolean
  • true if the lock is placed
  • false if the lock is not placed

Usage

IsDesignLockingEnabled in Database must be true or this method throws an exception.

The following actions occur depending on the current lock status: If the form is not locked, this method places the lock and returns true.

If the form is locked and the current user is one of the lock holders, this method returns true.

If the form is locked and the current user is not one of the lock holders, this method returns false.

If the form is modified by another user before the lock can be placed, this method throws an exception.