129 lines
3.1 KiB
Perl
129 lines
3.1 KiB
Perl
# --
|
|
# 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::System::CommunicationChannel::Base;
|
|
|
|
use strict;
|
|
use warnings;
|
|
|
|
our $ObjectManagerDisabled = 1;
|
|
|
|
=head1 NAME
|
|
|
|
Kernel::System::CommunicationChannel::Base - base class for communication channels
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
This is a base class for communication channels and should not be instantiated directly.
|
|
|
|
package Kernel::CommunicationChannel::MyChannel;
|
|
use parent 'Kernel::CommunicationChannel::Base';
|
|
|
|
# methods go here
|
|
|
|
=cut
|
|
|
|
=head1 PUBLIC INTERFACE
|
|
|
|
=head2 new()
|
|
|
|
Do not instantiate this class, instead use the real communication channel sub classes.
|
|
Also, don't use the constructor directly, use the ObjectManager instead:
|
|
|
|
my $ChannelObject = $Kernel::OM->Get('Kernel::System::CommunicationChannel::MyChannel');
|
|
|
|
=cut
|
|
|
|
sub new {
|
|
my ( $Type, %Param ) = @_;
|
|
|
|
# Die if someone tries to instantiate the base class.
|
|
if ( $Type eq __PACKAGE__ ) {
|
|
die 'Virtual method in base class must not be called.';
|
|
}
|
|
|
|
my $Self = {};
|
|
bless( $Self, $Type );
|
|
|
|
return $Self;
|
|
}
|
|
|
|
=head2 ArticleDataTables()
|
|
|
|
Returns list of communication channel article tables for backend data storage. All backends must
|
|
implement this method.
|
|
|
|
my @ArticleDataTables = $ChannelObject->ArticleDataTables();
|
|
|
|
@ArticleTables = (
|
|
'article_data_mime',
|
|
'article_data_mime_plain',
|
|
'article_data_mime_attachment',
|
|
);
|
|
|
|
=cut
|
|
|
|
sub ArticleDataTables {
|
|
die 'Virtual method in base class must not be called.';
|
|
}
|
|
|
|
=head2 ArticleDataArticleIDField()
|
|
|
|
Returns the name of the field used to link the channel article tables for backend data storage to
|
|
the main article table.
|
|
|
|
my $ArticleIDField = $ChannelObject->ArticleDataArticleIDField();
|
|
$ArticleIDField = 'article_id';
|
|
|
|
=cut
|
|
|
|
sub ArticleDataArticleIDField {
|
|
die 'Virtual method in base class must not be called.';
|
|
}
|
|
|
|
=head2 ArticleBackend()
|
|
|
|
Returns communication channel article backend object. Override this method in your class.
|
|
|
|
my $ArticleBackend = $ChannelObject->ArticleBackend();
|
|
|
|
This method will always return a valid object, so that you can chain-call on the return value like:
|
|
|
|
$ChannelObject->ArticleBackend()->ArticleGet(...);
|
|
|
|
=cut
|
|
|
|
sub ArticleBackend {
|
|
die 'Virtual method in base class must not be called.';
|
|
}
|
|
|
|
=head2 PackageNameGet()
|
|
|
|
Returns name of the package that provides communication channel. Override this method in your class.
|
|
|
|
my $PackageName = $ChannelObject->PackageNameGet();
|
|
$PackageName = 'MyPackage';
|
|
|
|
=cut
|
|
|
|
sub PackageNameGet {
|
|
die 'Virtual method in base class must not be called.';
|
|
}
|
|
|
|
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
|