lock (NotesAgent - JavaScript™)

Locks an agent.

Defined in

lock() : boolean

lock(provisionalock:boolean) : boolean

lock(name:string) : boolean

lock(name:string, provisionalock:boolean) : boolean

lock(names:java.util.Vector) : boolean

lock(names:java.util.Vector, provisionalock:boolean) : boolean


Parameter	Description
`name` or `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.
`provisionalock`	true to permit the placement of a provisional lock false (default) to not permit a provisional lock


Return value	Description
`boolean`	true if the lock is placed. false if the lock is not placed.

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

This method:

Places a persistent lock if the administration (master lock) server is available.
Places a provisional lock if the administration server is not available and the second parameter is true.
Throws an exception if the administration server is not available and the second parameter is false.

The following actions occur depending on the current lock status:

If the agent is not locked, this method places the lock and returns true.
If the agent is locked and the current user is one of the lock holders, this method returns true.
If the agent is locked and the current user is not one of the lock holders, this method returns false.
If the agent is modified by another user before the lock can be placed, this method throws an exception.