##############
ActivityDialog
##############


****
NAME
****


Kernel::System::ProcessManagement::ActivityDialog - activity dialog lib


***********
DESCRIPTION
***********


All Process Management Activity Dialog functions.


****************
PUBLIC INTERFACE
****************


new()
=====


Don't use the constructor directly, use the ObjectManager instead:


.. code-block:: perl

     my $ActivityDialogObject = $Kernel::OM->Get('Kernel::System::ProcessManagement::ActivityDialog');



ActivityDialogGet()
===================



.. code-block:: perl

     Get activity dialog info
 
     my $ActivityDialog = $ActivityDialogObject->ActivityDialogGet(
         ActivityDialogEntityID => 'AD1',
         Interface              => ['AgentInterface'],   # ['AgentInterface'] or ['CustomerInterface'] or ['AgentInterface', 'CustomerInterface'] or 'all'
         Silent                 => 1,    # 1 or 0, default 0, if set to 1, will not log errors about not matching interfaces
     );
 
     Returns:
 
     $ActivityDialog = {
         Name             => 'UnitTestActivity',
         Interface        => 'CustomerInterface',   # 'AgentInterface', 'CustomerInterface', ['AgentInterface'] or ['CustomerInterface'] or ['AgentInterface', 'CustomerInterface']
         DescriptionShort => 'AD1 Process Short',
         DescriptionLong  => 'AD1 Process Long description',
         CreateTime       => '07-02-2012 13:37:00',
         CreateBy         => '2',
         ChangeTime       => '08-02-2012 13:37:00',
         ChangeBy         => '3',
         Fields => {
             DynamicField_Make => {
                 Display          => 2,
                 DescriptionLong  => 'Make Long',
                 DescriptionShort => 'Make Short',
             },
             DynamicField_VWModel => {
                 Display          => 2,
                 DescriptionLong  => 'VWModel Long',
                 DescriptionShort => 'VWModel Short',
             },
             DynamicField_PeugeotModel => {
                 Display          => 0,
                 DescriptionLong  => 'PeugeotModel Long',
                 DescriptionShort => 'PeugeotModel Short',
             },
             StateID => {
                Display          => 1,
                DescriptionLong  => 'StateID Long',
                DescriptionShort => 'StateID Short',
             },
         },
         FieldOrder => [
             'StateID',
             'DynamicField_Make',
             'DynamicField_VWModelModel',
             'DynamicField_PeugeotModel'
         ],
         SubmitAdviceText => 'NOTE: If you submit the form ...',
         SubmitButtonText => 'Make an inquiry',
     };



ActivityDialogCompletedCheck()
==============================



.. code-block:: perl

     Checks if an activity dialog is completed
 
     my $Completed = $ActivityDialogObject->ActivityDialogCompletedCheck(
         ActivityDialogEntityID => 'AD1',
         Data                   => {
             Queue         => 'Raw',
             DynamicField1 => 'Value',
             Subject       => 'Testsubject',
             # ...
         },
     );
 
     Returns:
 
     $Completed = 1; # 0