########
Activity
########


****
NAME
****


Kernel::System::Activity - to manage the activity


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


All functions to manage the activity.


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


new()
=====


create an object


.. code-block:: perl

     my $ActivityObject = $Kernel::OM->Get('Kernel::System::Activity');



Add()
=====


Creates data attributes.


.. code-block:: perl

     my $CreatedID = $ActivityObject->Add(
         ID               => '...',
         Type             => '...',
         Title            => '...',
         Text             => '...',
         State            => '...',
         Link             => '...',
         CreateTime       => '...',
         CreateBy         => '...',
         UserID           => 1,
     );


Returns:


.. code-block:: perl

     my $CreatedID = 1;



GetLink()
=========


Returns a valid URL to the details dialog of the object with the given ID.


.. code-block:: perl

     my $String = $ActivityObject->GetLink(
         TicketID => 32,
 
         # OR:
         ApointmentID => 78,
     );


Returns:


.. code-block:: perl

     my $String = 'http://www.znuny.org/index.pl?Action=AgentTicketZoom;TicketID=1';



Get()
=====


Get data attributes with mapped icons.


.. code-block:: perl

     my $Success = $ActivityObject->Get();
         ID         => 1,
         Type       => '...', # optional
         Title      => '...', # optional
         Text       => '...', # optional
         State      => '...', # optional
         Link       => '...', # optional
         CreateTime => '...', # optional
         CreateBy   => '...', # optional
         UserID     => 123,
     );


Returns:


.. code-block:: perl

     my $Success = 1;



ListGet()
=========


Get list data with attributes with mapped icons.


.. code-block:: perl

     my @Activities = $ActivityObject->ListGet(
         ID         => '...', # optional
         Type       => '...', # optional
         Title      => '...', # optional
         Text       => '...', # optional
         State      => '...', # optional
         Link       => '...', # optional
         CreateTime => '...', # optional
         CreateBy   => '...', # optional
         UserID     => 123,
     );


Returns:


.. code-block:: perl

     my @Activities = 1;



DataAdd()
=========


creates data attributes


.. code-block:: perl

     my $CreatedID = $ActivityObject->DataAdd(
         ID         => '...',
         Type       => '...',
         Title      => '...',
         Text       => '...',
         State      => '...',
         Link       => '...',
         CreateTime => '...',
         CreateBy   => '...',
         UserID     => 1,
     );


Returns:


.. code-block:: perl

     my $CreatedID = 1;



DataGet()
=========


get data attributes


.. code-block:: perl

     my %Data = $ActivityObject->DataGet(
         ID         => '...', # optional
         Type       => '...', # optional
         Title      => '...', # optional
         Text       => '...', # optional
         State      => '...', # optional
         Link       => '...', # optional
         CreateTime => '...', # optional
         CreateBy   => '...', # optional
         UserID     => 1,
     );


Returns:


.. code-block:: perl

     my %Data = (
         ID         => '...',
         UserID     => 1,
         Type       => '...',
         Title      => '...',
         Text       => '...',
         State      => '...',
         Link       => '...',
         CreateTime => '...',
         CreateBy   => '...',
     );



DataListGet()
=============


get list data with attributes


.. code-block:: perl

     my @Data = $ActivityObject->DataListGet(
         ID         => '...', # optional
         Type       => '...', # optional
         Title      => '...', # optional
         Text       => '...', # optional
         State      => '...', # optional
         Link       => '...', # optional
         CreateTime => '...', # optional
         CreateBy   => '...', # optional
         UserID     => 1,
     );


Returns:


.. code-block:: perl

     my @Data = (
         {
             ID         => '...',
             UserID     => 1,
             Type       => '...',
             Title      => '...',
             Text       => '...',
             State      => '...',
             Link       => '...',
             CreateTime => '...',
             CreateBy   => '...',
         },
         # ...
     );



DataUpdate()
============


update data attributes


.. code-block:: perl

     my $Success = $ActivityObject->DataUpdate(
         ID     => 1234,
         UserID => 1,
         # all other attributes are optional
     );


Returns:


.. code-block:: perl

     my $Success = 1; # 1|0



DataDelete()
============


deletes data attributes - at least one is required.


.. code-block:: perl

     my $Success = $ActivityObject->DataDelete(
         ID         => '...', # optional
         Type       => '...', # optional
         Title      => '...', # optional
         Text       => '...', # optional
         State      => '...', # optional
         Link       => '...', # optional
         CreateTime => '...', # optional
         CreateBy   => '...', # optional
         UserID     => 1,
     );


Returns:


.. code-block:: perl

     my $Success = 1; # 1|0



DataSearch()
============


search for value in defined attributes


.. code-block:: perl

     my %Data = $ActivityObject->DataSearch(
         Search     => 'test*test',
         ID         => '...', # optional
         Type       => '...', # optional
         Title      => '...', # optional
         Text       => '...', # optional
         State      => '...', # optional
         Link       => '...', # optional
         CreateTime => '...', # optional
         CreateBy   => '...', # optional
         UserID     => 1,
     );


Returns:


.. code-block:: perl

     my %Data = (
         '1' => {
             'ID'         => '...',
             'Type'       => '...',
             'Title'      => '...',
             'Text'       => '...',
             'State'      => '...',
             'Link'       => '...',
             'CreateTime' => '...',
             'CreateBy'   => '...',
             'UserID'     => 1,
         },
         # ...
     );



InitConfig()
============


init config for object


.. code-block:: perl

     my $Success = $ActivityObject->InitConfig();


Returns:


.. code-block:: perl

     my $Success = 1;