AdministratorAction (OpenDJ Public API Javadoc 7.2.5-20240524201627-49403efab3a3556b93d8ee62f263ca29a7e752ef Documentation)

java.lang.Object
- org.forgerock.opendj.config.AdministratorAction

```
public final class AdministratorAction
extends Object
```
Defines an optional action which administators must perform after they have modified a property. By default modifications to properties are assumed to take effect immediately and require no additional administrative action. Developers should be aware that, where feasible, they should implement components such that property modifications require no additional administrative action. This is required in order to minimize server downtime during administration and provide a more user-friendly experience.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`AdministratorAction.Type`	Specifies the type of administrator action which must be performed in order for pending changes to take effect.

Constructor Summary

Constructors
Constructor	Description
`AdministratorAction(AdministratorAction.Type type, AbstractManagedObjectDefinition<?,?> d, String propertyName)`	Create a new administrator action.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`LocalizableMessage`	`getSynopsis()`	Gets the synopsis of this administrator action in the default locale.
`LocalizableMessage`	`getSynopsis(Locale locale)`	Gets the synopsis of this administrator action in the specified locale.
`AdministratorAction.Type`	`getType()`	Gets the type of this administrator action.
`String`	`toString()`

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

- Constructor Detail
  - AdministratorAction
```
public AdministratorAction(AdministratorAction.Type type,
                           AbstractManagedObjectDefinition<?,?> d,
                           String propertyName)
```
    Create a new administrator action.
    
    Parameters:
    
    type - The type of this administration action.
    
    d - The managed object definition associated with this administrator action.
    
    propertyName - The name of the property definition associated with this administrator action.
- Method Detail
  - getSynopsis
```
public LocalizableMessage getSynopsis()
```
    Gets the synopsis of this administrator action in the default locale.
    
    Returns:
    
    Returns the synopsis of this administrator action in the default locale, or null if there is no synopsis defined.
  - getSynopsis
```
public LocalizableMessage getSynopsis(Locale locale)
```
    Gets the synopsis of this administrator action in the specified locale.
    
    Parameters:
    
    locale - The locale.
    
    Returns:
    
    Returns the synopsis of this administrator action in the specified locale, or null if there is no synopsis defined.
  - getType
```
public AdministratorAction.Type getType()
```
    Gets the type of this administrator action.
    
    Returns:
    
    Returns the type of this administrator action.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object