ITSMChangeManagement -> rel-3_2 API documentation

NAME

Kernel::System::ITSMChange::ITSMStateMachine - statemachine lib

SYNOPSIS

All functions for statemachine 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::ITSMStateMachine;
  
  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 $StateMachineObject = Kernel::System::ITSMChange::ITSMStateMachine->new(
      ConfigObject => $ConfigObject,
      EncodeObject => $EncodeObject,
      LogObject    => $LogObject,
      DBObject     => $DBObject,
      TimeObject   => $TimeObject,
      MainObject   => $MainObject,
  );
  

• StateTransitionAdd()

  Add a new state transition. Returns the transition id on success.

  my $TransitionID = $StateMachineObject->StateTransitionAdd(
      StateID     => 1,                                       # id within the given class, or 0 to indicate the start state
      NextStateID => 2,                                       # id within the given class, or 0 to indicate an end state
      Class       => 'ITSM::ChangeManagement::Change::State', # the name of a general catalog class
  );
  

• StateTransitionDelete()

  Delete a state transition. Returns true on success.

  my $Success = $StateMachineObject->StateTransitionDelete(
      StateID     => 1,  # id within the given class, or 0 to indicate the start state
      NextStateID => 2,  # id within the given class, or 0 to indicate an end state
  );
  

• StateTransitionDeleteAll()

  Delete all state transitions of a class. Returns true on success.

  my $Success = $StateMachineObject->StateTransitionDeleteAll(
      Class => 'ITSM::ChangeManagement::Change::State', # the name of a general catalog class
  );
  

• StateTransitionGet()

  Get a state transition for a given state id. Returns an array reference of the next state ids.

  my $NextStateIDsRef = $StateMachineObject->StateTransitionGet(
      StateID => 1,                                       # id within the given class, or 0 to indicate the start state
      Class   => 'ITSM::ChangeManagement::Change::State', # the name of a general catalog class
  );
  

• StateTransitionGetEndStates()

  Get a state transition for a given state id, but only show the possible next end states. Returns an array reference of the next end state ids.

  my $NextStateIDsRef = $StateMachineObject->StateTransitionGetEndStates(
      StateID => 1,                                       # id within the given class, or 0 to indicate the start state
      Class   => 'ITSM::ChangeManagement::Change::State', # the name of a general catalog class
  );
  

• StateTransitionList()

  Return a state transition list hash-array reference. The hash key is the StateID, the hash value is an array reference of NextStateIDs.

  my $StateTransitionsRef = $StateMachineObject->StateTransitionList(
      Class => 'ITSM::ChangeManagement::Change::State', # the name of a general catalog class
  );
  

  Return example:

  $StateTransitionsRef = {
      0 => [ 1 ],
      1 => [ 2, 3, 4 ],
      2 => [ 5 ],
      3 => [ 6, 7 ],
      4 => [ 0 ],
      5 => [ 0 ],
      6 => [ 0 ],
      7 => [ 0 ],
  };
  

• StateTransitionUpdate()

  Update the next state of an existing new state transition. Returns the transition id on success.

  my $UpdateSuccess = $StateMachineObject->StateTransitionUpdate(
      StateID        => 1,                                       # id within the given class, or 0 to indicate the start state
      NextStateID    => 2,                                       # id within the given class, or 0 to indicate an end state
      NewNextStateID => 3,                                       # id within the given class, or 0 to indicate an end state
      Class          => 'ITSM::ChangeManagement::Change::State', # the name of a general catalog class
  );
  

• StateLookup()

  This method does a lookup for a state. If a state id is given, it returns the name of the state. If a state name is given, the appropriate id is returned.

  my $State = $StateMachineObject->StateLookup(
      StateID => 1234,
      Class   => 'ITSM::ChangeManagement::Change::State',
  );
  
  my $StateID = $StateMachineObject->StateLookup(
      State   => 'accepted',
      Class   => 'ITSM::ChangeManagement::Change::State',
  );
  

• StateList()

  This method returns a list of states for a catalog class.

  my $StateList = $StateMachineObject->StateList(
      Class  => 'ITSM::ChangeManagement::Change::State',
      UserID => 1,
  );
  

  The return value is a reference to an array of hashrefs. The element 'Key' is then the state id and the element 'Value' is the name of the state. The array elements are sorted by state id.

  my $StateList = [
      {
          Key   => 156,
          Value => 'approved',
      },
      {
          Key   => 157,
          Value => 'in progress',
      },
  ];
  

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

• Around line 11:

  =over without closing =back

• Around line 227:

  =cut found outside a pod block. Skipping to next block.