GeneralCatalog -> rel-2_1 API documentation

NAME

Kernel::System::GeneralCatalog - general catalog lib

SYNOPSIS

All general catalog functions.

PUBLIC INTERFACE

• new()

  create an object

  use Kernel::Config;
  use Kernel::System::Encode;
  use Kernel::System::Log;
  use Kernel::System::Main;
  use Kernel::System::DB;
  use Kernel::System::GeneralCatalog;
  
  my $ConfigObject = Kernel::Config->new();
  my $EncodeObject = Kernel::System::Encode->new(
      ConfigObject => $ConfigObject,
  );
  my $LogObject = Kernel::System::Log->new(
      ConfigObject => $ConfigObject,
      EncodeObject => $EncodeObject,
  );
  my $MainObject = Kernel::System::Main->new(
      ConfigObject => $ConfigObject,
      EncodeObject => $EncodeObject,
      LogObject    => $LogObject,
  );
  my $DBObject = Kernel::System::DB->new(
      ConfigObject => $ConfigObject,
      EncodeObject => $EncodeObject,
      LogObject    => $LogObject,
      MainObject   => $MainObject,
  );
  my $GeneralCatalogObject = Kernel::System::GeneralCatalog->new(
      ConfigObject => $ConfigObject,
      EncodeObject => $EncodeObject,
      LogObject    => $LogObject,
      DBObject     => $DBObject,
      MainObject   => $MainObject,
  );
  

• ClassList()

  return an array reference of all general catalog classes

  my $ArrayRef = $GeneralCatalogObject->ClassList();
  

• ClassRename()

  rename a general catalog class

  my $True = $GeneralCatalogObject->ClassRename(
      ClassOld => 'ITSM::ConfigItem::State',
      ClassNew => 'ITSM::ConfigItem::DeploymentState',
  );
  

• ItemList()

  return a list as hash reference of one general catalog class

  my $HashRef = $GeneralCatalogObject->ItemList(
      Class         => 'ITSM::Service::Type',
      Valid         => 0,                      # (optional) default 1
      Preferences   => {                       # (optional) default {}
          Permission => 2,                     # or whatever preferences can be used
      },
  );
  

• ItemGet()

  get a general catalog item

  Return $ItemData{ItemID} $ItemData{Class} $ItemData{Name} $ItemData{ValidID} $ItemData{Comment} $ItemData{CreateTime} $ItemData{CreateBy} $ItemData{ChangeTime} $ItemData{ChangeBy}

  my $ItemDataRef = $GeneralCatalogObject->ItemGet(
      ItemID => 3,
  );
  
  or
  
  my $ItemDataRef = $GeneralCatalogObject->ItemGet(
      Class => 'ITSM::Service::Type',
      Name  => 'Item Name',
  );
  

• ItemAdd()

  add a new general catalog item

  my $ItemID = $GeneralCatalogObject->ItemAdd(
      Class         => 'ITSM::Service::Type',
      Name          => 'Item Name',
      ValidID       => 1,
      Comment       => 'Comment',              # (optional)
      UserID        => 1,
  );
  

• ItemUpdate()

  update a existing general catalog item

  my $True = $GeneralCatalogObject->ItemUpdate(
      ItemID        => 123,
      Name          => 'Item Name',
      ValidID       => 1,
      Comment       => 'Comment',    # (optional)
      UserID        => 1,
  );
  

• GeneralCatalogPreferencesSet()

  set GeneralCatalog preferences

  $GeneralCatalogObject->GeneralCatalogPreferencesSet(
      ItemID => 123,
      Key    => 'UserComment',
      Value  => 'some comment',
  );
  

• GeneralCatalogPreferencesGet()

  get GeneralCatalog preferences

  my %Preferences = $QueueObject->GeneralCatalogPreferencesGet(
      ItemID => 123,
  );
  

TERMS AND CONDITIONS

This Software is part of the OTRS project (http://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 http://www.gnu.org/licenses/gpl-2.0.txt.

VERSION

$Revision: 1.52.2.1 $ $Date: 2011-05-16 11:54:00 $