1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
# --
# Copyright (C) 2001-2021 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
|
