NAME

BuildForge::API::Adaptor


SYNOPSIS

        my $Adaptor = new BuildForge::API::Adaptor();
        $Adaptor->{'template'} = "ClearQuest";
        $Adaptor->{'name'} = "My ClearQuest Adaptor";
        $Adaptor->{'type'} = "Defect";
        $Adaptor->Create();
        
        my $Adaptor = new BuildForge::API::Adaptor({name=>"My ClearQuest Adaptor"});
        print "Existing XML: $Adaptor->{'xml'}\n";
        $Adaptor->{'xml'} = $NewXML;
        $Adaptor->Update();
        print "New XML: $Adaptor->{'xml'}\n";


DESCRIPTION

    This is available to use after a BuildForge::API object has been 
instantiated. It is used to create new BuildForge Adaptors, and to access 
existing adaptor information.


METHODS

new({AdaptorParamsHashRef})

Create an object to access existing adaptor information or to add a new adaptor to the BuildForge console.

name
The name for the adaptor

type
The adaptor type (Source, Test, or Defect)

template
The template to use for populating a new adaptor

xml
The xml for a new or existing adaptor

Create()

Create a new Adaptor inside BuildForge. Requires Adaptor 'name', and 'type' to be set, as well as either the 'xml' or 'template' values.

Update()

Updates the adaptor inside BuildForge. Requires the Adaptor 'name', 'type' and 'xml' fields to be set. This can update either or both of 'type' and 'xml'.

GetLastError()

Returns the last error code encountered by the object.

GetLastMessage()

Returns an last message string encountered by the object.

Sync()

Syncs the object with information from the console database. Requires the Adaptor 'name' to be set.


AUTHOR

BuildForge, Inc.