NAME

BuildForge::Services::DBO::Register


SYNOPSIS

        use BuildForge::Services;
        $conn = new BuildForge::Services::Connection($hostname);
        $token = $conn->authUser($user, $pass);
        
        # Getting existing registers
        $buildRegisters = BuildForge::Services::DBO::Register->findAllRegistersByBuild($conn, $buildId);
        $buildRegisters = BuildForge::Services::DBO::Register->findAllRegistersByProject($conn, $projectId);
        $register1 = BuildForge::Services::DBO::Register->findBuildRegisterById($conn, $buildId, 'REGNAME1');
        $register2 = BuildForge::Services::DBO::Register->findProjectRegisterById($conn, $projectId, 'REGNAME2');
        # Getter / setter functions
        $buildId = $register1->getBuildId();
        $projectId = $register1->getProjectId();
        $userId = $register1->getUserId();
        $registerName = $register1->getRegister();
        $registerValue = $register1->getDataText();
        $timestamp = $register1->getStamp();
        $register1->setBuildId($buildId);
        $register1->setProjectId($projectId);
        $register1->setRegister('NEWREGNAME');
        $register1->setDataText('Register Contents');
        $register1->setStamp($now);
        $register1->update();
        
        # Register creation, updating, deletion
        $newregister = new BuildForge::Services::DBO::Register($conn);
        $newregister->setRegister('New Build Register');
        $newregister->setDataText('Register Contents');
        $newregister->setProjectId($projectId);
        $newregister->create();
        $register1->setRegister('DIFFERENTREGNAME');
        $newregister->update();
        
        $newregister->delete();
        BuildForge::Services::DBO::Register->deleteBuildRegister($conn, $register1->getBuildId(), 
                        $register1->getRegister());
        BuildForge::Services::DBO::Register->deleteProjectRegister($conn, $register2->getProjectId(), 
                        $register2->getRegister());
        BuildForge::Services::DBO::Register->deleteAllRegistersByBuild($conn, $buildId);
        BuildForge::Services::DBO::Register->deleteAllRegistersByProject($conn, $projectId);
                
        $conn->logout;
        $conn->close;


DESCRIPTION

Register allows you to create, access, and delete BuildForge project and build registers.


METHODS

new BuildForge::Services::DBO::Register(connection{RegisterParamsHashRef})

Returns a new instance of a Register object.

connection

A connected BuildForge::Services::Connection object.

RegisterParamsHashRef

An optional reference to a hash containing any or all of the following fields.

buildId

0 to make this a project register, otherwise a build ID (from $build->getBuildId()) to make it a build register attached to that build.

projectId

For a build register, this value is ignored. For a project register, a project ID (from $project->getProjectId()) to make it a project register attached to that project.

register

The name of the register.

dataText

The contents of the register.

BuildForge::Services::DBO::Register->findAllRegistersByBuild(connection, buildId)

Returns a reference to an array of all BuildForge::Services::DBO::Register objects that refer to build registers associated with the given build.

connection

A connected BuildForge::Services::Connection object.

buildId

The build ID (from $build->getBuildId()) for the desired build.

BuildForge::Services::DBO::Register->findAllRegistersByProject(connection, projectId)

Returns a reference to an array of all BuildForge::Services::DBO::Register objects that refer to project registers associated with the given project.

connection

A connected BuildForge::Services::Connection object.

projectId

The project ID (from $project->getProjectId()) for the desired project.

BuildForge::Services::DBO::Register->findBuildRegisterById(connection, buildId, registerName)

Returns the BuildForge::Services::DBO::Register object for the desired build register or undef if it does not exist.

connection

A connected BuildForge::Services::Connection object.

buildId

The build ID (from $build->getBuildId()) for the desired build.

registerName

The register name (from $register->getRegister()) of the desired register.

BuildForge::Services::DBO::Register->findProjectRegisterById(connection, projectId, registerName)

Returns the BuildForge::Services::DBO::Register object for the desired project register or undef if it does not exist.

connection

A connected BuildForge::Services::Connection object.

projectID

The project ID (from $project->getProjectId()) for the desired project.

registerName

The register name (from $register->getRegister()) of the desired register.

$register->create()

Creates the register in the database.

$register->update()

Updates the register in the database.

$register->delete()

Deletes the register from the database.

BuildForge::Services::DBO::Register->deleteBuildRegister(connection, buildId, registerName)

Deletes the given build register from the database.

connection

A connected BuildForge::Services::Connection object.

buildId

The build ID (from $build->getBuildId()) for the desired build.

registerName

The register name (from $register->getRegister()) of the desired register.

BuildForge::Services::DBO::Register->deleteProjectRegister(connection, projectId, registerName)

Deletes the given project register from the database.

connection

A connected BuildForge::Services::Connection object.

projectId

The project ID (from $project->getProjectId()) for the desired project.

registerName

The register name (from $register->getRegister()) of the desired register.

BuildForge::Services::DBO::Register->deleteAllRegistersByBuild(connection, buildId)

Deletes all build registers from the database attached to the given build.

connection

A connected BuildForge::Services::Connection object.

buildId

The build ID (from $build->getBuildId()) for the desired build.

BuildForge::Services::DBO::Register->deleteAllRegistersByProject(connection, projectId)

Deletes all project registers from the database attached to the given project.

connection

A connected BuildForge::Services::Connection object.

projectId

The project ID (from $project->getProjectId()) for the desired project.

$register->getBuildId()

Returns the register's build ID if it is a build register or 0 otherwise.

$register->getProjectId()

Returns the register's project ID if it is a project register or 0 otherwise.

$register->getUserId()

Returns the user ID of the user who created this register.

$register->getRegister()

Returns the register's name.

$register->getStamp()

Returns the timestamp for when the register value was last updated.

$register->getDataText()

Returns the value of the register.

$register->setBuildId(buildId)

Sets the build ID of the associated build for build registers. $register->update() must be run before changes are replicated in the database.

buildId

0 to make this a project register, otherwise a build ID (from $build->getBuildId()) to make it a build register attached to that build.

$register->setProjectId(projectId)

Sets the project ID of the associated project for project registers. If the register is a build register, this value will be ignored. $register->update() must be run before changes are replicated in the database.

projectId

The project ID (from $project->getProjectId()) of the project to which to attach this project register.

$register->setRegister(registerName)

Sets the name of the register. $register->update() must be run before changes are replicated in the database.

registerName

The new name for the register.

$register->setDataText(value)

Sets the value of the register. $register->update() must be run before changes are replicated in the database.

value

The new value for the register.


COPYRIGHT

Copyright (c)2006-2007 International Business Machines, Inc. All rights reserved.