NAME

Kernel::System::StatsReport

DESCRIPTION

Backend for statistics reports.

PUBLIC INTERFACE

StatsReportAdd()

add new StatsReport.

returns id of new StatsReport if successful or undef otherwise

    my $ID = $StatsReportObject->StatsReportAdd(
        Name    => 'some name',
        Config  => $ConfigHashRef,
        ValidID => 1,
        UserID  => 123,
    );

StatsReportGet()

get StatsReports attributes

    my $StatsReport = $StatsReportObject->StatsReportGet(
        ID   => 123,            # ID or Name must be provided
        Name => 'MyStatsReport',
    );

Returns:

    $StatsReport = {
        ID         => 123,
        Name       => 'some name',
        Config     => $ConfigHashRef,
        ValidID    => 123,
        CreateTime => '2011-02-08 15:08:00',
        ChangeTime => '2011-02-08 15:08:00',
    };

StatsReportUpdate()

update StatsReport attributes

returns 1 if successful or undef otherwise

    my $Success = $StatsReportObject->StatsReportUpdate(
        ID      => 123,
        Name    => 'some name',
        Config  => $ConfigHashRef,
        ValidID => 1,
        UserID  => 123,
    );

StatsReportDelete()

delete a StatsReport

returns 1 if successful or undef otherwise

    my $Success = $StatsReportObject->StatsReportDelete(
        ID      => 123,
        UserID  => 123,
    );

StatsReportList()

get StatsReport list

    my $List = $StatsReportObject->StatsReportList();

    or

    my $List = $StatsReportObject->StatsReportList(
        Valid => 0, # optional, defaults to 1
    );

StatisticReportListGet()

Sorts and filters report data.

    OrderBy   => 'StatisticID' || 'ID' || 'Title' || 'Object', # optional
    Direction => 'ASC' || 'DESC',             # optional

Returns an array reference containing all report IDs.