lockProvisional (Agent - Java™)

Locks an agent provisionally.

Note: This method is new with Release 6.5.

Defined in

Agent

Syntax

public boolean lockProvisional()
    throws NotesException
public boolean lockProvisional(String name)
    throws NotesException
public boolean lockProvisional(java.util.Vector names)
    throws NotesException

Parameters

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

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 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.

Example