1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
'\" te
.\" Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH Exacct::Object::Group 3PERL "1 Dec 2002" "SunOS 5.11" "Perl Library Functions"
.SH NAME
Exacct::Object::Group \- exacct group manipulation
.SH SYNOPSIS
.LP
.nf
use Sun::Solaris::Exacct::Object;
my $ea_grp = Sun::Solaris::Exacct::Object::Group->new(
& EXT_GROUP | &EXC_DEFAULT | &EXD_GROUP_PROC);
.fi
.SH DESCRIPTION
.sp
.LP
This module is used for manipulating \fBlibexacct\fR(3LIB) Group objects. A
\fBlibexacct\fR Group object is represented as an opaque reference blessed into
the \fBSun::Solaris::Exacct::Object::Group\fR class, which is a subclass of the
\fBSun::Solaris::Exacct::Object\fR class. The Items within a Group are stored
inside a Perl array. A reference to the array can be accessed with the
inherited \fBvalue()\fR method. The individual Items within a Group can be
manipulated with the normal Perl array syntax and operators. All data elements
of the array must be derived from the \fBSun::Solaris::Exacct::Object\fR class.
Group objects can also be nested inside each other simply by adding an existing
Group as a data Item.
.SS "Constants"
.sp
.LP
None.
.SS "Functions"
.sp
.LP
None.
.SS "Class methods"
.sp
.LP
Class methods include those inherited from the
\fBSun::Solaris::Exacct::Object\fR base class, plus the following:
.sp
.ne 2
.mk
.na
\fB\fBnew($catalog, @objects)\fR\fR
.ad
.RS 27n
.rt
This method creates and returns a new
\fBSun::Solaris::Exacct::Object::Group\fR. The catalog tag can be either an
integer or a \fBSun::Solaris::Exacct::Catalog\fR. The catalog tag should be a
valid catalog tag for a Perl exacct Group object. The \fB@objects\fR parameter
is a list of \fBSun::Solaris::Exacct::Object\fR to be stored inside the Group.
A copy of all the passed Items is taken and any Group objects are recursively
copied. The contents of the returned Group object can be accessed with the
array returned by the value method.
.RE
.SS "Object methods"
.sp
.ne 2
.mk
.na
\fB\fBas_hash()\fR\fR
.ad
.RS 17n
.rt
This method returns the contents of the group as a hash reference. It uses the
string value of each item's catalog ID as the hash entry key and the scalar
value returned by \fBvalue()\fR as the hash entry value. This form should be
used if there are no duplicate catalog tags in the group.
.sp
This method and its companion \fBas_hashlist()\fR are the fastest ways to
access the contents of a Group.
.RE
.sp
.ne 2
.mk
.na
\fB\fBas_hashlist()\fR\fR
.ad
.RS 17n
.rt
This method returns the contents of the group as a hash reference. It uses the
string value of each item's catalog id as the hash entry key and an array of
the scalar values returned by \fBvalue()\fR as the hash entry value for all the
items that share a common key. This form should be used if there might be
duplicate catalog tags in the group.
.sp
This method and its companion \fBas_hash()\fR are the fastest ways to access
the contents of a Group.
.RE
.SS "Exports"
.sp
.LP
None.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i)
lw(2.75i) |lw(2.75i)
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityEvolving
.TE
.SH SEE ALSO
.sp
.LP
\fBExacct\fR(3PERL), \fBExacct::Catalog\fR(3PERL), \fBExacct::File\fR(3PERL),
\fBExacct::Object\fR(3PERL), \fBExacct::Object::Item\fR(3PERL),
\fBlibexacct\fR(3LIB), \fBattributes\fR(5)
|