NAME

Kernel::System::LinkObject::FAQ

DESCRIPTION

FAQ backend for the link object.

PUBLIC INTERFACE

new()

create an object. Do not use it directly, instead use:

    use Kernel::System::ObjectManager;
    local $Kernel::OM = Kernel::System::ObjectManager->new();
    my $FAQObjectBackend = $Kernel::OM->Get('Kernel::System::LinkObject::FAQ');

LinkListWithData()

fill up the link list with data

    $Success = $FAQLinkObject->LinkListWithData(
        LinkList => $HashRef,
        UserID   => 1,
    );

BuildObjectTitleString()

Builds the object title string with the given object data.

    $BuildObjectTitleString = $LinkObject->BuildObjectTitleString(
        Data => { ... },
    );

Return

    $BuildObjectTitleString = 'FAQ#123: Example';

ObjectTypeNameForFrontend()

Gives the object type name for the frontend from the different backends. Normally it's the same, but in same cases it's different.

    $ObjectTypeNameForFrontend = $LinkObject->ObjectTypeNameForFrontend();

Return

    $ObjectTypeNameForFrontend = 'KnowledgeBaseArticle';

ObjectPermission()

checks read permission for a given object and UserID.

    $Permission = $FAQLinkObject->ObjectPermission(
        Object  => 'FAQ',
        Key     => 123,
        UserID  => 1,
    );

ObjectDescriptionGet()

return a hash of object descriptions

Return %Description = ( Normal => "FAQ# 1234", Long => "FAQ# 1234: FAQTitle", );

    %Description = $FAQLinkObject->ObjectDescriptionGet(
        Key     => 123,
        UserID  => 1,
    );

ObjectSearch()

return a hash list of the search results

Return $SearchList = { NOT-LINKED => { Source => { 12 => $DataOfItem12, 212 => $DataOfItem212, 332 => $DataOfItem332, }, }, };

    $SearchList = $LinkObjectBackend->ObjectSearch(
        SearchParams => $HashRef,  # (optional)
        UserID       => 1,
    );

LinkAddPre()

link add pre event module

    $True = $FAQLinkObject->LinkAddPre(
        Key          => 123,
        SourceObject => 'FAQ',
        SourceKey    => 321,
        Type         => 'Normal',
        State        => 'Valid',
        UserID       => 1,
    );

    or

    $True = $FAQLinkObject->LinkAddPre(
        Key          => 123,
        TargetObject => 'FAQ',
        TargetKey    => 321,
        Type         => 'Normal',
        State        => 'Valid',
        UserID       => 1,
    );

LinkAddPost()

link add pre event module

    $True = $FAQLinkObject->LinkAddPost(
        Key          => 123,
        SourceObject => 'FAQ',
        SourceKey    => 321,
        Type         => 'Normal',
        State        => 'Valid',
        UserID       => 1,
    );

    or

    $True = $FAQLinkObject->LinkAddPost(
        Key          => 123,
        TargetObject => 'FAQ',
        TargetKey    => 321,
        Type         => 'Normal',
        State        => 'Valid',
        UserID       => 1,
    );

LinkDeletePre()

link delete pre event module

    $True = $FAQLinkObject->LinkDeletePre(
        Key          => 123,
        SourceObject => 'FAQ',
        SourceKey    => 321,
        Type         => 'Normal',
        State        => 'Valid',
        UserID       => 1,
    );

    or

    $True = $FAQLinkObject->LinkDeletePre(
        Key          => 123,
        TargetObject => 'FAQ',
        TargetKey    => 321,
        Type         => 'Normal',
        State        => 'Valid',
        UserID       => 1,
    );

LinkDeletePost()

link delete post event module

    $True = $FAQLinkObject->LinkDeletePost(
        Key          => 123,
        SourceObject => 'FAQ',
        SourceKey    => 321,
        Type         => 'Normal',
        State        => 'Valid',
        UserID       => 1,
    );

    or

    $True = $FAQLinkObject->LinkDeletePost(
        Key          => 123,
        TargetObject => 'FAQ',
        TargetKey    => 321,
        Type         => 'Normal',
        State        => 'Valid',
        UserID       => 1,
    );