NAME
Kernel::System::GeneralCatalog – general catalog lib
PUBLIC INTERFACE
BUILD()
Customization of object construction, do not use it directly.
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()
returns a list as a 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 item attributes
my $ItemDataRef = $GeneralCatalogObject->ItemGet(
ItemID => 3,
IncludesPreferences => '0|1', # optional, default '1'
);
or
my $ItemDataRef = $GeneralCatalogObject->ItemGet(
Class => 'ITSM::Service::Type',
Name => 'Underpinning Contract',
IncludesPreferences => '0|1', # optional, default '1'
);
returns
my $Item = {
'ItemID' => '23',
'Class' => 'ITSM::Service::Type',
'Name' => 'Underpinning Contract'
'Comment' => 'Some Comment',
'ValidID' => '1',
'CreateTime' => '2012-01-12 09:36:24',
'CreateBy' => '1',
'ChangeTime' => '2012-01-12 09:36:24',
'ChangeBy' => '1',
};
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 an 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 = $GeneralCatalogObject->GeneralCatalogPreferencesGet(
ItemID => 123,
);