Interface PostPardonEvent

All Superinterfaces:
space.arim.omnibus.events.AsyncEvent, space.arim.omnibus.events.Event, PostOpNotificationEvent
public interface PostPardonEvent extends space.arim.omnibus.events.AsyncEvent, PostOpNotificationEvent
Called once a punishment has been revoked
Author:
A248

  • Method Summary

    Modifier and Type
    Method
    Description
    Operator
    getOperator()
    Gets the staff member who revoked the punishment
    Punishment
    getPunishment()
    Gets the punishment revoked
    default Optional<String>
    getTarget()
    The command line target of the removal.
    default boolean
    isSilent()
    If the punishment was removed silently.

  • Method Details

    • getOperator

      Operator getOperator()
      Gets the staff member who revoked the punishment
      Returns:
      the operator responsible for the pardon

    • getPunishment

      Punishment getPunishment()
      Gets the punishment revoked
      Specified by:
      getPunishment in interface PostOpNotificationEvent
      Returns:
      the punishment which was revoked

    • getTarget

      default Optional<String> getTarget()
      The command line target of the removal.

      This is not necessarily the same as the punished victim (PunishmentBase.getVictim()), but rather the string argument interpreted to mean it. In some contexts this argument will be unavailable; for example, removing a punishment by its ID alone has no target argument.

      Specified by:
      getTarget in interface PostOpNotificationEvent
      Returns:
      the targeted user (victim name) on the command line, if available

    • isSilent

      default boolean isSilent()
      If the punishment was removed silently.
      Specified by:
      isSilent in interface PostOpNotificationEvent
      Returns:
      true if silent