NAME

BuildForge::API::Step


SYNOPSIS

        my $Step = new BuildForge::API::Step();
        $Step->{'title'} = "My Build Step";
        $Step->{'command'} = "make mysteptarget";
        $Project->AddStep($Step);


DESCRIPTION

    This is available to use after a BuildForge::API object has been 
instantiated. Typically Step objects are used in conjunction with a Project
object. The BuildForge API allows for creation, modification, and deletion of
Project Steps.


METHODS

new({StepParamsHashRef})

Create an object to access and modify existing step information, or to create new steps.

title
The name of the step.

command
The command to execute for this step.

environment_id
ID of the environment group to use (integer)

filter_id
ID of the filter set to use

inline_chain_id
Project ID of the project to inline chain

dir
Sub-path to run the command in.

pass_notify_group
Group name to notify upon step pass

fail_notify_group
Group name to notify upon step failure

onfail
Continue on fail status, if filter_id is not set (0 or 1)

selector
Name of the selector to use with this step.

threading
Thread this step ('Y' or 'N' or 'J')

absolute
This step should not create/use project dir (0 or 1)

timeout
Step timeout (string)

access_group_id
ID of the access level for this step

broadcast
Broadcast step to pool (0 or 1)

pass_chain_id
Project ID to chain on pass

fail_chain_id
Project ID to chain on fail

pass_wait
Wait for Chained Pass Project to complete (0 or 1)

fail_wait
Wait for Chained Fail Project to complete (0 or 1)

pass_notify_changers
Notify changeset info users on pass (0 or 1)

fail_notify_changers
Notify changeset info users on fail (0 or 1)

GetLastError()

Returns the last error code encountered by the object.

GetLastMessage()

Returns the last message string encountered by the object.

Sync()

Populates the object with information from the console database. The step object should be instantiated with one of the hash refs returned from the StepList method of a Project object.

Enable()

Enables the step.

Disable()

Disables the step.


AUTHOR

BuildForge, Inc.