CommandAvailability (Nuxeo 2021.70.4 API Documentation)

java.lang.Object
- org.nuxeo.ecm.platform.commandline.executor.api.CommandAvailability

All Implemented Interfaces:

Serializable
```
public class CommandAvailability
extends Object
implements Serializable
```
Represents the availability status of a command. If command is not available, CommandAvailability contains the errorMessage and some installation instructions.

Author:

tiry

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected boolean available

protected String errorMessage

protected String installMessage

Constructor Summary

Constructors
Constructor	Description
`CommandAvailability()`
`CommandAvailability(String errorMessage)`
`CommandAvailability(String installMessage, String errorMessage)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

String getErrorMessage()

String getInstallMessage()

boolean isAvailable()
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

installMessage
```
protected final String installMessage
```

errorMessage
```
protected final String errorMessage
```

available
```
protected final boolean available
```

Constructor Detail

CommandAvailability

public CommandAvailability(String installMessage,
                           String errorMessage)

CommandAvailability

public CommandAvailability(String errorMessage)

CommandAvailability
```
public CommandAvailability()
```

Method Detail

getInstallMessage
```
public String getInstallMessage()
```

getErrorMessage
```
public String getErrorMessage()
```

isAvailable
```
public boolean isAvailable()
```