ITSMChangeManagement -> rel-3_2 API documentation

NAME

Kernel::System::ITSMChange::ITSMCondition - condition lib

SYNOPSIS

All functions for conditions in ITSMChangeManagement.

PUBLIC INTERFACE

• new()

  create an object

  use Kernel::Config;
  use Kernel::System::Encode;
  use Kernel::System::Log;
  use Kernel::System::DB;
  use Kernel::System::Main;
  use Kernel::System::Time;
  use Kernel::System::ITSMChange::ITSMCondition;
  
  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 $TimeObject = Kernel::System::Time->new(
      ConfigObject => $ConfigObject,
      LogObject    => $LogObject,
  );
  my $DBObject = Kernel::System::DB->new(
      ConfigObject => $ConfigObject,
      EncodeObject => $EncodeObject,
      LogObject    => $LogObject,
      MainObject   => $MainObject,
  );
  my $ConditionObject = Kernel::System::ITSMChange::ITSMCondition->new(
      ConfigObject => $ConfigObject,
      EncodeObject => $EncodeObject,
      LogObject    => $LogObject,
      DBObject     => $DBObject,
      TimeObject   => $TimeObject,
      MainObject   => $MainObject,
  );
  

• ConditionAdd()

  Add a new condition.

  my $ConditionID = $ConditionObject->ConditionAdd(
      ChangeID              => 123,
      Name                  => 'The condition name',
      ExpressionConjunction => 'any',                 # (any|all)
      Comment               => 'A comment',           # (optional)
      ValidID               => 1,
      UserID                => 1,
  );
  

• ConditionUpdate()

  Update a condition.

  my $Success = $ConditionObject->ConditionUpdate(
      ConditionID           => 1234,
      Name                  => 'The condition name',  # (optional)
      ExpressionConjunction => 'any',                 # (optional) (any|all)
      Comment               => 'A comment',           # (optional)
      ValidID               => 1,                     # (optional)
      UserID                => 1,
  );
  

• ConditionGet()

  Returns a hash reference of the condition data for a given ConditionID.

  my $ConditionData = $ConditionObject->ConditionGet(
      ConditionID => 123,
      UserID      => 1,
  );
  

  The returned hash reference contains following elements:

  $ConditionData{ConditionID}
  $ConditionData{ChangeID}
  $ConditionData{Name}
  $ConditionData{ExpressionConjunction}
  $ConditionData{Comment}
  $ConditionData{ValidID}
  $ConditionData{CreateTime}
  $ConditionData{CreateBy}
  $ConditionData{ChangeTime}
  $ConditionData{ChangeBy}
  

• ConditionList()

  return a list of all conditions ids of a given change id as array reference. The ids are sorted by the name of the condition.

  my $ConditionIDsRef = $ConditionObject->ConditionList(
      ChangeID => 5,
      Valid    => 0,   # (optional) default 1 (0|1)
      UserID   => 1,
  );
  

• ConditionDelete()

  Delete a condition.

  my $Success = $ConditionObject->ConditionDelete(
      ConditionID => 123,
      UserID      => 1,
  );
  

• ConditionDeleteAll()

  Delete all conditions for a given ChangeID. All related expressions and actions will be deleted first.

  my $Success = $ConditionObject->ConditionDeleteAll(
      ChangeID => 123,
      UserID   => 1,
  );
  

• ConditionMatchExecuteAll()

  This functions finds the valid conditions for a given ChangeID. The found conditions are handled by executing the associated actions when a condition matches. The conditions are handled in the order defined by their names.

  Internally, the method ConditionMatchExecute() is called for each of the found conditions. The optional parameter 'AttributesChanged' is passed on to ConditionMatchExecute().

  my $Success = $ConditionObject->ConditionMatchExecuteAll(
      ChangeID          => 123,
      AttributesChanged => { ITSMChange => [ ChangeTitle, ChangeDescription] },  # (optional)
      Event             => 'ChangeUpdate',                                       # (optional)
      UserID            => 1,
  );
  

• ConditionMatchExecute()

  This function matches the given condition. When it matches the associated actions are executed.

  The optional parameter 'AttributesChanged' defines a list of attributes that were changed during e.g. a ChangeUpdate-Event. When 'AttributesChanged' is passed, it is used to shortcut the expression evalution. Only the changed attributes must be checked. When the expression conjunction is 'any' and more than a single expression is set up, then, for obvious reasons, the shortcut is not used.

  my $Success = $ConditionObject->ConditionMatchExecute(
      ConditionID       => 123,
      AttributesChanged => { ITSMChange => [ ChangeTitle, ChangeDescription] },  # (optional)
      Event             => 'ChangeUpdate',                                       # (optional)
      UserID            => 1,
  );
  

• ConditionMatchStateLock()

  my $Success = $ConditionObject->ConditionMatchStateLock(
      ObjectName => 'ITSMChange',
      Selector   => 234,
      StateID    => 123,
      UserID     => 1,
  );
  

• ConditionCompareValueFieldType()

  Returns the type of the compare value field as string, based on the given object id and attribute id.

  my $FieldType = $ConditionObject->ConditionCompareValueFieldType(
      ObjectID    => 1234,
      AttributeID => 5,
      UserID      => 1,
  );
  

  Returns 'Text' or 'Selection' or 'Date'.

  TODO: Add 'Autocomplete' type for ChangeBuilder, ChangeManager, WorkOrderAgent, etc...

• ConditionListByObjectType()

  Return a list of all conditions ids of a given change id as array reference. Only the ids of a condition are returned where object type and identifier are matching.

  my $ConditionIDsRef = $ConditionObject->ConditionListByObjectType(
      ObjectType => 'ITSMWorkOrder'
      Selector   => 1234,
      ChangeID   => 5,
      UserID     => 1,
  );
  

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 (AGPL). If you did not receive this file, see http://www.gnu.org/licenses/agpl.txt.