NAME Activity.pm

Object oriented interface to UCM Activities

VERSION

Author

Andrew DeFaria <Andrew@ClearSCM.com>

Revision

Revision 1.10

Created

Fri May 14 18:16:16 PDT 2010

Modified

Modifed 2011/11/15 01:56:40

SYNOPSIS

Provides access to information about Clearcase Activites.

 my $activity = new Clearcase::UCM::Activity ($name, $pvob);
 
 my @changeset = $activity->changeset;
 
 for my $element (@changeset) {
   display "Element name: "    . $element->pname;
   display "Element verison: " . $element->version;
 } # for

DESCRIPTION

This module implements a UCM Activity object

ROUTINES

The following routines are exported:

new

Construct a new Clearcase Activity object.

Parameters:

activity name

Name of activity

Returns:

Clearcase Activity object

name

Returns the name of the activity

Parameters:

none

Returns:

activity's name

pvob

Returns the pvob of the activity

Parameters:

none

Returns:

activity's pvob

type

Returns the type of the activity

Parameters:

none

Returns:

activity's type

contrib_acts

Returns the contributing activities

Parameters:

none

Returns:

Array of contributing activities

crm_record_id

Returns the crm_record_id of the activity

Parameters:

none

Returns:

activity's crm_record_id

crm_record_type

Returns the crm_record_type of the activity

Parameters:

none

Returns:

activity's crm_record_type

crm_state

Returns the crm_state of the activity

Parameters:

none

Returns:

activity's crm_state

headline

Returns the headline of the activity

Parameters:

none

Returns:

activity's headline

name_resolver_view

Returns the name_resolver_view of the activity

Parameters:

none

Returns:

activity's name_resolver_view

stream

Returns the stream of the activity

Parameters:

none

Returns:

activity's stream

changeset

Returns the changeset of the activity

Parameters:

none

Returns:

An array containing Clearcase::Element objects.

create

Creates a new UCM Activity

Parameters:

UCM Stream(required)

UCM stream this activities is to be created on

PVOB (Required)

Project Vob

headline

Headline to associate with this activity

Returns:

$status

Status from cleartool

@output

Ouput from cleartool

remove

Removes UCM Activity

Parameters:

none

Returns:

$status

Status from cleartool

@output

Ouput from cleartool

attributes

Returns a hash of the attributes associated with an activity

Parameters:

none

Returns:

%attributes

Hash of attributes for this activity

DEPENDENCIES

ClearSCM Perl Modules

Clearcase

INCOMPATABILITIES

None

BUGS AND LIMITATIONS

There are no known bugs in this module.

Please report problems to Andrew DeFaria <Andrew@ClearSCM.com>.

LICENSE AND COPYRIGHT

Copyright (c) 2007, ClearSCM, Inc. All rights reserved.