.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "CipUX::Object::Action::List 3pm"
.TH CipUX::Object::Action::List 3pm "2015-07-23" "perl v5.20.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
CipUX::Object::Action::List \- Object layer class for CipUX
.SH "VERSION"
.IX Header "VERSION"
version 3.4.0.5
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use CipUX::Object::Action::List;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Provides the functions cipux_object_create and cipux_object_destroy
as well as some auto-calculated values for example for userPassword.
.SH "ABSTRACT"
.IX Header "ABSTRACT"
The CipUX object layer is a generic abstract class, which can be
used by other classes or scripts.
.PP
The function cipux_object_create may create one or several \s-1LDAP\s0 nodes
according to the configuration structure in /etc/cipux/cipux\-object.conf
or ~/.cipux/cipux\-object.conf.
.PP
The function cipux_object_destroy tries to remove one or more \s-1LDAP\s0
nodes.
.SH "SUBROUTINES/METHODS"
.IX Header "SUBROUTINES/METHODS"
The following functions will be exported by CipUX::Object::Action::List.
.SS "new"
.IX Subsection "new"
Constructor
.PP
\&\fBSyntax:\fR
.PP
.Vb 1
\&  my $cipux_object = CipUX::Object::Action::List\->new({});
\&
\&  my $cipux_object = CipUX::Object::Action::List\->new({debug=>1});
\&
\&  my $cfg = \*(Aq/etc/cipux/cipux\-object.conf\*(Aq;
\&  my $cipux_object = CipUX::Object::Action::List\->new({cfg=>$cfg});
.Ve
.PP
\&\fBDescription:\fR
.PP
\&\fIcfg\fR
.PP
Configuration files may be provided for convenience. This is meant to work in
a single-server scenario and multi-server settings.
.PP
The preset behavior is to throw an exception, when some parameter value of
the configuration file is missing or is wrong.
.PP
Summary:
.PP
.Vb 6
\& * if a configuration file is given
\&      incorporate this file if it is there
\&   else
\&      look for ~/.cipux/cipux\-object.conf and incorporate if it is there
\&   else
\&      look for /etc/cipux/cipux\-object.conf and incorporate if it is there
.Ve
.PP
\&\fB/etc/cipux/cipux\-object.conf\fR
.PP
The configuration file is for dispatching multiple CipUX objects.
.PP
\&\s-1TODO:\s0 write conf structure!
.PP
For details see man page of cipux\-object.conf.
.SS "\s-1DESTROY\s0"
.IX Subsection "DESTROY"
Mandatory \s-1DESTROY\s0 Method for Inside-Out Class.
.PP
\&\fBSyntax:\fR
.PP
.Vb 1
\&   $i10n\->DESTROY();
.Ve
.SS "list_type"
.IX Subsection "list_type"
Creates a CipUX object
.PP
\&\fBSyntax:\fR
.PP
.Vb 1
\& $object\->list_type({
\&
\&                              });
.Ve
.SS "preset"
.IX Subsection "preset"
Creates a CipUX object
.PP
\&\fBSyntax:\fR
.PP
.Vb 1
\& $object\->preset({
\&
\&                              });
.Ve
.SS "auto"
.IX Subsection "auto"
Creates a CipUX object
.PP
\&\fBSyntax:\fR
.PP
.Vb 1
\& $object\->auto({
\&
\&                              });
.Ve
.SS "mandatory"
.IX Subsection "mandatory"
Creates a CipUX object
.PP
\&\fBSyntax:\fR
.PP
.Vb 1
\& $object\->mandatory({
\&
\&                              });
.Ve
.SS "rule"
.IX Subsection "rule"
Creates a CipUX object
.PP
\&\fBSyntax:\fR
.PP
.Vb 1
\& $object\->rule({
\&
\&                              });
.Ve
.SS "alias"
.IX Subsection "alias"
Creates a CipUX object
.PP
\&\fBSyntax:\fR
.PP
.Vb 1
\& $object\->alias({
\&
\&                              });
.Ve
.SS "list_object_action"
.IX Subsection "list_object_action"
\&\s-1TODO\s0
.SS "preset_auto_mandatory_rule_alias"
.IX Subsection "preset_auto_mandatory_rule_alias"
Creates a CipUX object
.PP
\&\fBSyntax:\fR
.PP
.Vb 1
\& $object\->preset_auto_mandatory_rule_alias({
.Ve
.PP
});
.SS "oid_number_supremum"
.IX Subsection "oid_number_supremum"
\&\s-1TODO\s0
.SS "object"
.IX Subsection "object"
\&\s-1TODO\s0
.SS "test_cfg"
.IX Subsection "test_cfg"
\&\s-1TODO\s0
.SS "\s-1DEMOLISH\s0"
.IX Subsection "DEMOLISH"
\&\s-1TODO\s0
.SS "config"
.IX Subsection "config"
\&\s-1TODO\s0
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
\&\s-1TODO\s0
.SH "CONFIGURATION AND ENVIRONMENT"
.IX Header "CONFIGURATION AND ENVIRONMENT"
\&\s-1TODO\s0
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
Carp
Class:Std
CipUX
CipUX::Storage
Pod::Usage
Date::Manip
.SH "INCOMPATIBILITIES"
.IX Header "INCOMPATIBILITIES"
Not known.
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
Not known.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
See the CipUX web page and the manual at <http://www.cipux.org>
.PP
See the mailing list <http://sympa.cipworx.org/wws/info/cipux\-devel>
.SH "AUTHOR"
.IX Header "AUTHOR"
Christian Kuelker  <christian.kuelker@cipworx.org>
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright (C) 2007 \- 2009 by Christian Kuelker
.PP
This program is free software; you can redistribute it and/or
modify it under the terms of the \s-1GNU\s0 General Public License as
published by the Free Software Foundation; either version 2, or (at
your option) any later version.
.PP
This program is distributed in the hope that it will be useful, but
\&\s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE. \s0 See the \s-1GNU\s0
General Public License for more details.
.PP
You should have received a copy of the \s-1GNU\s0 General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, \s-1MA
02111\-1307 USA\s0