init III

Perl OTRS/Kernel/Output/HTML/TicketBulk/Base.pm

@@ -0,0 +1,110 @@
+# --
+# Copyright (C) 2001-2019 OTRS AG, https://otrs.com/
+# --
+# This software comes with ABSOLUTELY NO WARRANTY. For details, see
+# the enclosed file COPYING for license information (GPL). If you
+# did not receive this file, see https://www.gnu.org/licenses/gpl-3.0.txt.
+# --
+
+package Kernel::Output::HTML::TicketBulk::Base;
+
+use strict;
+use warnings;
+
+our @ObjectManagerDisabled = 1;
+
+=head1 NAME
+
+Kernel::Output::HTML::TicketBulk::Base - ticket bulk module base class
+
+=head1 DESCRIPTION
+
+Base class for ticket bulk modules.
+
+=head1 PUBLIC INTERFACE
+
+=head2 Display()
+
+Generates the required HTML to display new fields in ticket bulk screen. It requires to get the value from the web request (e.g. in case of an error to re-display the field content).
+
+    my $ModuleContent = $ModuleObject->Display(
+        Errors       => $ErrorsHashRef,             # created in ticket bulk and updated by Validate()
+        UserID       => $123,
+    );
+
+Returns:
+
+    $ModuleContent = $HMLContent;                   # HTML content of the field
+
+Override this method in your modules.
+
+=cut
+
+sub Display {
+    my ( $Self, %Param ) = @_;
+
+    return;
+}
+
+=head2 Validate()
+
+Validates the values of the ticket bulk module. It requires to get the value from the web request.
+
+    my @Result = $ModuleObject->Validate(
+        UserID       => $123,
+    );
+
+Returns:
+
+    @Result = (
+        {
+            ErrorKey   => 'SomeFieldName',
+            ErrorValue => 'SomeErrorMessage',
+        }
+       # ...
+    );
+
+Override this method in your modules.
+
+=cut
+
+sub Validate {
+    my ( $Self, %Param ) = @_;
+
+    return ();
+}
+
+=head2 Store()
+
+Stores the values of the ticket bulk module. It requires to get the values from the web request.
+
+    my @Success = $ModuleObject->Store(
+        TicketID => 123,
+        UserID   => 123,
+    );
+
+Returns:
+
+    $Success = 1,       # or false in case of an error;
+
+Override this method in your modules.
+
+=cut
+
+sub Store {
+    my ( $Self, %Param ) = @_;
+
+    return;
+}
+
+1;
+
+=head1 TERMS AND CONDITIONS
+
+This software is part of the OTRS project (L<https://otrs.org/>).
+
+This software comes with ABSOLUTELY NO WARRANTY. For details, see
+the enclosed file COPYING for license information (GPL). If you
+did not receive this file, see L<https://www.gnu.org/licenses/gpl-3.0.txt>.
+
+=cut