NAME

Kernel::System::ProcessManagement::DB::SequenceFlowAction

DESCRIPTION

Process Management DB SequenceFlowAction backend

PUBLIC INTERFACE

new()

Don't use the constructor directly, use the ObjectManager instead:

    my $SequenceFlowActionObject = $Kernel::OM->Get('Kernel::System::ProcessManagement::DB::SequenceFlowAction');

SequenceFlowActionAdd()

add new SequenceFlowAction

returns the id of the created SequenceFlowAction if success or undef otherwise

    my $ID = $SequenceFlowActionObject->SequenceFlowActionAdd(
        EntityID    => 'SFA1'                      # mandatory, exportable unique identifier
        Name        => 'NameOfSequenceFlowAction', # mandatory
        Config      => $ConfigHashRef,             # mandatory, sequence flow action configuration to be
                                                   #    stored in YAML format
        UserID      => 123,                        # mandatory
    );

Returns:

    $ID = 567;

SequenceFlowActionDelete()

delete an SequenceFlowAction

returns 1 if success or undef otherwise

    my $Success = $SequenceFlowActionObject->SequenceFlowActionDelete(
        ID      => 123,
        UserID  => 123,
    );

SequenceFlowActionGet()

get SequenceFlowAction attributes

    my $SequenceFlowAction = $SequenceFlowActionObject->SequenceFlowActionGet(
        ID            => 123,            # ID or EntityID is needed
        EntityID      => 'P1',
        UserID        => 123,            # mandatory
    );

Returns:

    $SequenceFlowAction = {
        ID           => 123,
        EntityID     => 'SFA1',
        Name         => 'some name',
        Config       => $ConfigHashRef,
        CreateTime   => '2012-07-04 15:08:00',
        ChangeTime   => '2012-07-04 15:08:00',
    };

SequenceFlowActionUpdate()

update SequenceFlowAction attributes

returns 1 if success or undef otherwise

    my $Success = $SequenceFlowActionObject->SequenceFlowActionUpdate(
        ID          => 123,                        # mandatory
        EntityID    => 'SFA1'                      # mandatory, exportable unique identifier
        Name        => 'NameOfSequenceFlowAction', # mandatory
        Config      => $ConfigHashRef,             # mandatory, activity dialog configuration to be
                                                   #   stored in YAML format
        UserID      => 123,                        # mandatory
    );

SequenceFlowActionList()

get an SequenceFlowAction list

    my $List = $SequenceFlowActionObject->SequenceFlowActionList(
        UseEntities => 0,                       # default 0, 1 || 0. if 0 the return hash keys are
                                                #    the sequence flow action IDs otherwise keys are
                                                #    the sequence flow action entity IDs
        UserID      => 1,
    );

    Returns:

    $List = {
        1 => 'NameOfSequenceFlowAction',
    }

    or

    $List = {
        'SF1' => 'NameOfSequenceFlowAction',
    }

SequenceFlowActionListGet()

get a Sequence Flow Action list with all Sequence Flow Action details

    my $List = $SequenceFlowActionObject->SequenceFlowActionListGet(
        UserID      => 1,
    );

Returns:

    $List = [
        {
            ID             => 123,
            EntityID       => 'SFA1',
            Name           => 'some name',
            Config         => $ConfigHashRef,
            CreateTime     => '2012-07-04 15:08:00',
            ChangeTime     => '2012-07-04 15:08:00',
        }
        {
            ID             => 456,
            EntityID       => 'SFA2',
            Name           => 'some name',
            Config         => $ConfigHashRef,
            CreateTime     => '2012-07-04 15:09:00',
            ChangeTime     => '2012-07-04 15:09:00',
        }
    ];