ClearSCM Inc.

NAME Element.pm

Object oriented interface to Clearcase Elements

VERSION

Author

Andrew DeFaria <Andrew@ClearSCM.com>

Revision

Revision 1.6

Created

Thu Dec 29 12:07:59 PST 2005

Modified

Modifed 2010/05/20 03:58:04

SYNOPSIS

Provides access to information about Clearcase Elements.

  my $element = new Clearcase::Element (pname => "element");

  display "Element:\t"  . $element->pname;
  display "Version:\t"  . $element->version;
  display "Pred:\t\t"   . $element->pred;

  display "Activities:";

  if (my %activities = $element->activities) {
    display "\t\t$_: $activities{$_}" foreach (keys %activities);
  } else {
    display "\t\tNone";
  } # if

  display "Attributes:";

  if (my %attributes = $element->attributes) {
    display "\t\t$_=$attributes{$_}" foreach (keys %attributes);
  } else {
    display"\t\tNone";
  } # if

  display "Hyperlinks:";

  if (my @hyperlinks = $element->hyperlinks) {
    display "\t\t$_" foreach (@hyperlinks);
  } else {
    display "\t\tNone";
  } # if

  display "Comments:";

  if ($element->comments) {
    display "\t\t" . $element->comments;
  } else {
    display "\t\tNone";
  } # if

  display "Create_date:\t"      . $element->create_date;
  display "User:\t\t"           . $element->user;
  display "Group:\t\t"          . $element->group;
  display "User_mode:\t"        . $element->user_mode;
  display "Group_mode:\t"       . $element->group_mode;
  display "Other_mode:\t"       . $element->other_mode;
  display "Mode:\t\t"           . $element->mode;

  display "Labels:";

  if (my @labels = $element->labels) {
    display "\t\t$_" foreach (@labels);
  } else {
    display "\t\tNone";
  } # if

  display "Rule:\t\t"           . $element->rule;
  display "Xname:\t\t"          . $element->xname;

DESCRIPTION

This module implements a Clearcase Element object.

ROUTINES

The following routines are exported:

new

Construct a new Clearcase Element object.

Parameters:

none

Returns:

Clearcase Element object

activities

Returns a hash of activity name/value pairs

Parameters:

none

Returns:

Hash of activity name/value pairs

attributes

Returns a hash of attribute name/value pairs

Parameters:

none

Returns:

Hash of attribute name/value pairs

comments

Returns the comments associated with the current version element.

Parameters:

none

Returns:

comment

create_date

Returns the date of creation of the element.

Parameters:

none

Returns:

create date

group

Returns the group of the element.

Parameters:

none

Returns:

group

group_mode

Returns the group mode of the element

Parameters:

none

Returns:

group mode

hyperlinks

Returns a hash of hyperlink name/value pairs

Parameters:

none

Returns:

Hash of hyperlink name/value pairs

labels

Returns an array of labels

Parameters:

none

Returns:

Array of labels

mode

Returns the numeric mode representing the element's access mode

Parameters:

none

Returns:

Array of activities

other_mode

Returns the mode for other for the element.

Parameters:

none

Returns:

A string repesenting the other mode

pname

Returns the pname of the element.

Parameters:

none

Returns:

pname

pred

Returns the predecessor version of this element

Parameters:

none

Returns:

Predecessor version

rule

Returns the config spec rule that selected this element's version.

Parameters:

none

Returns:

rule

type

Returns the element's type

Parameters:

none

Returns:

element type

objkind

Returns the element's object kind

Parameters:

none

Returns:

element's object kind

oid

Returns the element's OID

Parameters:

none

Returns:

element's OID

user

Returns the username of the owner of this element.

Parameters:

none

Returns:

user name

user_mode

Returns the mode for the user for the element.

Parameters:

none

Returns:

A string repesenting the other mode

version

Returns this element's version

Parameters:

none

Returns:

version

xname

Returns the view extended path name (xname) of an element version.

Parameters:

none

Returns:

xname

mkelem

Returns creates a new element

Parameters:

Comment

Creation comment. Default -nc.

Returns:

$status

Status from cleartool

@output

Ouput from cleartool

checkout

Checks out the element

Parameters:

comment

Checkout comment. Default -nc.

Returns:

$status

Status from cleartool

@output

Ouput from cleartool

checkin

Checks in the element

Parameters:

comment

Check in comment. Default -nc.

Returns:

$status

Status from cleartool

@output

Ouput from cleartool

DEPENDENCIES

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.