RT::Client::REST::Transaction(3pm)

1RT::Client::REST::TransUascetrioCno(n3t)ributed Perl DocRuTm:e:nCtlaiteinotn::REST::Transaction(3)
2
3
4

NAME

6       RT::Client::REST::Transaction -- this object represents a transaction.
7

SYNOPSIS

9         my $transactions = $ticket->transactions;
10
11         my $count = $transactions->count;
12         print "There are $count transactions.\n";
13
14         my $iterator = $transactions->get_iterator;
15         while (my $tr = &$iterator) {
16             print "Id: ", $tr->id, "; Type: ", $tr->type, "\n";
17         }
18

DESCRIPTION

20       A transaction is a second-class citizen, as it does not exist (at least
21       from the current REST protocol implementation) by itself.  At the
22       moment, it is always associated with a ticket (see parent_id
23       attribute).  Thus, you will rarely retrieve a transaction by itself;
24       instead, you should use "transactions()" method of
25       RT::Client::REST::Ticket object to get an iterator for all (or some)
26       transactions for that ticket.
27

ATTRIBUTES

29       id
30         Numeric ID of the transaction.
31
32       creator
33         Username of the user who created the transaction.
34
35       parent_id
36         Numeric ID of the object the transaction is associated with.
37
38       type
39         Type of the transactions.  Please referer to RT::Client::REST
40         documentation for the list of transaction types you can expect this
41         field to contain.  Note that there may be some transaction types not
42         (dis)covered yet.
43
44       old_value
45         Old value.
46
47       new_value
48         New value.
49
50       field
51         Name of the field the transaction is describing (if any).
52
53       attachments
54         I have never seen it set to anything yet.  (I will some day
55         investigate this).
56
57       created
58         Time when the transaction was created.
59
60       content
61         Actual content of the transaction.
62
63       description
64         Human-readable description of the transaction as provided by RT.
65
66       data
67         Not sure what this is yet.
68

METHODS

70       RT::Client::REST::Transaction is a read-only object, so you cannot
71       "store()" it.  Also, because it is a second-class citizen, you cannot
72       "search()" or "count()" it -- use "transactions()" method provided by
73       RT::Client::REST::Ticket.
74
75       retrieve
76         To retrieve a transaction, attributes id and parent_id must be set.
77

INTERNAL METHODS

79       rt_type
80         Returns 'transaction'.
81

AUTHOR

87       Dmitri Tikhonov <dtikhonov@yahoo.com>
88

LICENSE

90       Perl license with the exception of RT::Client::REST, which is GPLed.
91
92
93
94perl v5.12.0                      2007-12-23  RT::Client::REST::Transaction(3)