NAME

Kernel::System::ProcessManagement::DB::SequenceFlow

DESCRIPTION

Process Management DB SequenceFlow backend

PUBLIC INTERFACE

new()

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

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

SequenceFlowAdd()

add new SequenceFlow

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

    my $ID = $SequenceFlowObject->SequenceFlowAdd(
        EntityID    => 'SF1'                   # mandatory, exportable unique identifier
        Name        => 'NameOfSequenceFlow',   # mandatory
        Config      => $ConfigHashRef,         # mandatory, sequence flow configuration to be stored in
                                               #   YAML format
        UserID      => 123,                    # mandatory
    );

Returns:

    $ID = 567;

SequenceFlowDelete()

delete an SequenceFlow

returns 1 if success or undef otherwise

    my $Success = $SequenceFlowObject->SequenceFlowDelete(
        ID      => 123,
        UserID  => 123,
    );

SequenceFlowGet()

get SequenceFlow attributes

    my $SequenceFlow = $SequenceFlowObject->SequenceFlowGet(
        ID            => 123,            # ID or EntityID is needed
        EntityID      => 'SF1',
        UserID        => 123,            # mandatory
    );

Returns:

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

SequenceFlowUpdate()

update SequenceFlow attributes

returns 1 if success or undef otherwise

    my $Success = $SequenceFlowObject->SequenceFlowUpdate(
        ID          => 123,                  # mandatory
        EntityID    => 'SF1'                 # mandatory, exportable unique identifier
        Name        => 'NameOfSequenceFlow', # mandatory
        Config      => $ConfigHashRef,       # mandatory, sequence flow configuration to be stored in
                                             #   YAML format
        UserID      => 123,                  # mandatory
    );

SequenceFlowList()

get an SequenceFlow list

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

    Returns:

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

    or

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

SequenceFlowListGet()

get a SequenceFlow list with all SequenceFlow details

    my $List = $SequenceFlowObject->SequenceFlowListGet(
        UserID      => 1,
    );

Returns:

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