Interface UserBan

  • All Known Implementing Classes:
    UserBan

    public interface UserBan
    • Method Summary

      Modifier and Type Method Description
      User getBanningUser()
      Gets the user that created this ban record, null if no reason was supplied.
      java.util.Date getDate()
      Gets the date that the ban was created.
      java.util.Date getEnd()
      Gets the date that the ban ends, null if there is no end.
      java.lang.String getReason()
      Gets the reason for the user being banned.
      User getUser()
      Gets the user that was banned.
      boolean isPardoned()
      Finds if the ban has been pardoned.
      void pardon()
      Pardons the ban.
    • Method Detail

      • getUser

        User getUser()
        Gets the user that was banned.
        Returns:
        banned user instance.
      • getReason

        java.lang.String getReason()
        Gets the reason for the user being banned.
        Returns:
        ban reason.
      • getBanningUser

        User getBanningUser()
        Gets the user that created this ban record, null if no reason was supplied.
        Returns:
        ban reason.
      • getDate

        java.util.Date getDate()
        Gets the date that the ban was created.
        Returns:
        Date instance.
      • getEnd

        java.util.Date getEnd()
        Gets the date that the ban ends, null if there is no end.
        Returns:
        Ban end.
      • isPardoned

        boolean isPardoned()
        Finds if the ban has been pardoned.
        Returns:
        true if the ban was pardoned, false otherwise.
      • pardon

        void pardon()
             throws java.lang.SecurityException
        Pardons the ban.
        Throws:
        java.lang.SecurityException