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 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
|
# --
# 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::ProcessManagement::DB::Process::State;
use strict;
use warnings;
use Kernel::Language qw(Translatable);
our @ObjectDependencies = (
'Kernel::System::Log',
);
=head1 NAME
Kernel::System::ProcessManagement::DB::Process::State
=head1 DESCRIPTION
Process Management DB State backend
=head1 PUBLIC INTERFACE
=head2 new()
Don't use the constructor directly, use the ObjectManager instead:
my $ProcessStateObject = $Kernel::OM->Get('Kernel::System::ProcessManagement::DB::Process::State');
=cut
sub new {
my ( $Type, %Param ) = @_;
# allocate new hash for object
my $Self = {};
bless( $Self, $Type );
# create States list
$Self->{StateList} = {
'S1' => Translatable('Active'),
'S2' => Translatable('Inactive'),
'S3' => Translatable('FadeAway'),
};
return $Self;
}
=head2 StateList()
get a State list
my $List = $StateObject->StateList(
UserID => 123,
);
Returns:
$List = {
'S1' => 'Active',
'S2' => 'Inactive',
'S3' => 'FadeAway',
}
=cut
sub StateList {
my ( $Self, %Param ) = @_;
# check needed
if ( !$Param{UserID} ) {
$Kernel::OM->Get('Kernel::System::Log')->Log(
Priority => 'error',
Message => "Need UserID!",
);
return;
}
return $Self->{StateList};
}
=head2 StateLookup()
get State name or State EntityID
my $Name = $StateObject->StateLookup(
EntityID => 'S1',
UserID => 123,
);
Returns:
$Name = 'Active';
my $EntityID = $StateObject->StateLookup(
Name => 'Active',
UserID => 123,
);
Returns:
$EntityID = 'S1';
=cut
sub StateLookup {
my ( $Self, %Param ) = @_;
# check needed
if ( !$Param{UserID} ) {
$Kernel::OM->Get('Kernel::System::Log')->Log(
Priority => 'error',
Message => "Need UserID!",
);
return;
}
if ( !$Param{EntityID} && !$Param{Name} ) {
$Kernel::OM->Get('Kernel::System::Log')->Log(
Priority => 'error',
Message => "EntityID or Name is required!",
);
return;
}
# return state name
my $Result;
if ( $Param{EntityID} ) {
$Result = $Self->{StateList}->{ $Param{EntityID} };
}
# return state entity ID
else {
my %ReversedStateList = reverse %{ $Self->{StateList} };
$Result = $ReversedStateList{ $Param{Name} };
}
return $Result;
}
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
|