LockOperationVote (iKnowBase API Documentation)

```
public interface LockOperationVote
```
Event sent before a lock is required. Event consumers may abort the lock process with abortOperation(reason).

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class LockOperationVote.LockOperationDecision
Decisions available.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`abortOperation(String reason)`	Abort the vote
`String`	`getAbortReason()`	Retrieve the current abort reason
`LockOperationVote.LockOperationDecision`	`getDecision()`	Retrieve the current decision
`Integer`	`getDocumentId()`	Return Document ID for the lock notification
`LockOperation`	`getLockOperation()`	Retrieve LockOperation from this event
`String`	`getToken()`	Return Lock Token for the lock notification
`String`	`getUsername()`	Return authenticated username for the lock notification

- Method Detail
  - getLockOperation
```
LockOperation getLockOperation()
```
    Retrieve LockOperation from this event
    
    Returns:
    
    LockOperation
  - getUsername
```
String getUsername()
```
    Return authenticated username for the lock notification
    
    Returns:
    
    username
  - getDocumentId
```
Integer getDocumentId()
```
    Return Document ID for the lock notification
    
    Returns:
    
    documentId
  - getToken
```
String getToken()
```
    Return Lock Token for the lock notification
    
    Returns:
    
    token
  - getDecision
```
LockOperationVote.LockOperationDecision getDecision()
```
    Retrieve the current decision
    
    Returns:
    
    decision
  - getAbortReason
```
String getAbortReason()
```
    Retrieve the current abort reason
    
    Returns:
    
    abortReason
  - abortOperation
```
void abortOperation(String reason)
```
    Abort the vote
    
    Parameters:
    
    reason - describing WHY you abort the lock operation