Package com.io7m.idstore.shell.admin.internal.formatting

# Interface IdAFormatterType

All Known Implementing Classes:
  `IdAFormatterPretty`, `IdAFormatterRaw`

public interface IdAFormatterType
A shell formatter for data.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `formatAdmin(IdAdmin admin)`
  Format an admin.
  `void`
  `formatAdmins(IdPage<IdAdminSummary> page)`
  Format a page of admins.
  `void`
  `formatAudits(IdPage<IdAuditEvent> page)`
  Format a page of audit events.
  `void`
  `formatLoginHistory(List<IdLogin> history)`
  Format a history.
  `void`
  `formatUser(IdUser user)`
  Format a user.
  `void`
  `formatUsers(IdPage<IdUserSummary> page)`
  Format a page of users.

- ## Method Details

  - ### formatAdmin

    void formatAdmin(IdAdmin admin) throws Exception
    Format an admin.
    Parameters:
      `admin` - The admin
    Throws:
      `Exception` - On errors

  - ### formatAdmins

    void formatAdmins(IdPage<IdAdminSummary> page) throws Exception
    Format a page of admins.
    Parameters:
      `page` - The page
    Throws:
      `Exception` - On errors

  - ### formatAudits

    void formatAudits(IdPage<IdAuditEvent> page) throws Exception
    Format a page of audit events.
    Parameters:
      `page` - The page
    Throws:
      `Exception` - On errors

  - ### formatUsers

    void formatUsers(IdPage<IdUserSummary> page) throws Exception
    Format a page of users.
    Parameters:
      `page` - The page
    Throws:
      `Exception` - On errors

  - ### formatLoginHistory

    void formatLoginHistory(List<IdLogin> history) throws Exception
    Format a history.
    Parameters:
      `history` - The history
    Throws:
      `Exception` - On errors

  - ### formatUser

    void formatUser(IdUser user) throws Exception
    Format a user.
    Parameters:
      `user` - The user
    Throws:
      `Exception` - On errors