SessionCommandBuilder.TerminateBuilder (1C:Enterprise Development Tools 1.27.0-SNAPSHOT API)

java.lang.Object
- com.e1c.g5.v8.dt.platform.standaloneserver.core.SessionCommandBuilder.CommandLineBuilderWithMandatoryParameters
- - com.e1c.g5.v8.dt.platform.standaloneserver.core.SessionCommandBuilder.TerminateBuilder

Enclosing class:: SessionCommandBuilder

public static class SessionCommandBuilder.TerminateBuilder
extends SessionCommandBuilder.CommandLineBuilderWithMandatoryParameters

Builds arguments for the 'terminate' command.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected String`	`getThisArgument()`	Gets name of the argument represented by this builder.
`SessionCommandBuilder.TerminalCommandLineBuilder`	`sessionId(String sessionUUID)`	Specifies session identifier to terminate.
`SessionCommandBuilder.TerminateBuilder`	`withErrorMessage(String message)`	Specify a reason for closing the session.

Methods inherited from class com.e1c.g5.v8.dt.platform.standaloneserver.core.SessionCommandBuilder.CommandLineBuilderWithMandatoryParameters
addOption, collectArguments, getInitialArguments, getOptionsForThisArgument

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - sessionId
```
public SessionCommandBuilder.TerminalCommandLineBuilder sessionId(String sessionUUID)
```
    Specifies session identifier to terminate.
    
    Parameters:
    
    sessionUUID - identifier of the session to terminate.
    
    Returns:
    
    Command line builder. Never null.
  - withErrorMessage
```
public SessionCommandBuilder.TerminateBuilder withErrorMessage(String message)
```
    Specify a reason for closing the session.
    
    Returns:
    
    Command line builder. Never null.
  - getThisArgument
```
protected String getThisArgument()
```
    Description copied from class: SessionCommandBuilder.CommandLineBuilderWithMandatoryParameters
    
    Gets name of the argument represented by this builder.
    
    Specified by:
    
    getThisArgument in class SessionCommandBuilder.CommandLineBuilderWithMandatoryParameters
    
    Returns:
    
    Name of the argument or null if no argument is to be added by the builder itself.