# $Id$

#
# Copyright (c) 2001-2012 NetApp, Inc., All Rights Reserved
#   Any use, modification, or distribution is prohibited
#   without prior written consent from NetApp, Inc.
#

## @summary DebugLocksLockSync ComponentState Module (auto-generated by CGT)
## @author dl-nacl-dev@netapp.com
## @status shared
## @pod here

=head1 NAME

NACL::CS::DebugLocksLockSync

=head1 DESCRIPTION

C<NACL::CS::DebugLocksLockSync> is a derived class of
L<NACL::CS::ComponentState::ONTAP|lib-NACL-CS-ComponentState-ONTAP-pm>. It represents the
state of an ONTAP DebugLocksLockSync.  A related class is
L<NACL::C::DebugLocksLockSync|lib-NACL-C-DebugLocksLockSync-pm>, which represents access
to an ONTAP DebugLocksLockSync.

=head1 ATTRIBUTES

The individual pieces of data that are part of the state of the DebugLocksLockSync
element are the attributes of the DebugLocksLockSync ComponentState. 

Additionally, the command_interface used to obtain the ComponentState object is 
also an attribute of the object. This makes it easier to obtain the component
object corresponding to the CS object, using 
L<get_component_instance|lib-NACL-CS-ComponentState-pm/get_component_instance>.

=over

=item command_interface

The command_interface with which the CS object was obtained. (Available in
all CS objects regardless of requested_fields and the mode/interface)

=item C<< locks_total >>

*Total locks to be checked for sync

Filled in for CMode CLI.

=item C<< locks_remaining >>

*Remaining locks to be checked for sync

Filled in for CMode CLI.

=item C<< in_progress >>

*Lock Sync In Progress, possible value(s) are true,false

Filled in for CMode CLI.

=item C<< percent_complete >>

*Percent Complete

Filled in for CMode CLI.

=item C<< filer >>

*Filer

Filled in for CMode CLI.

=item C<< node >>

Node possible value(s) are, nodename

Filled in for CMode CLI.

=item C<< last_complete_time >>

Time Last Completed possible value(s) are, text

Filled in for CMode CLI.

=item C<< last_start_time >>

Time Last Started possible value(s) are, text

Filled in for CMode CLI.

=item C<< status >>

Status

Filled in for CMode CLI.

=item C<< mirrored_opens_remaining >>

Remaining Opens to Be Checked for Sync
Filled in for CMode CLI.

=item C<< mirrored_opens_total >>

Total Opens to Be Checked for Sync
Filled in for CMode CLI.


=back

=cut

package NACL::CS::DebugLocksLockSync;

use strict;
use warnings;
use Params::Validate qw(validate);
use NATE::Log qw(log_global);
my $Log = log_global();
my $may_enter = $Log->may_enter();
my $may_exit  = $Log->may_exit();

use NACL::Exceptions::NoElementsFound qw(:try);

use base 'NACL::CS::ComponentState::ONTAP';

use Class::MethodMaker [
    scalar => 'locks_total',
    scalar => 'locks_remaining',
    scalar => 'in_progress',
    scalar => 'percent_complete',
    scalar => 'filer',
    scalar => 'node',
    scalar => 'last_complete_time',
    scalar => 'last_start_time',
    scalar => 'status',
    scalar => 'mirrored_opens_remaining',
    scalar => 'mirrored_opens_total',
];

=head1 METHODS

=head2 fetch

    my $DebugLocksLockSync_state  = NACL::CS::DebugLocksLockSync->fetch(command_interface => $ci, ...);
	my @DebugLocksLockSync_states = NACL::CS::DebugLocksLockSync->fetch(command_interface => $ci, ...);

(Class method)
Discovers which elements are present and returns their state in ComponentState
objects. Called in scalar context it returns only one state object, in list
context it returns all state objects.
See L<NACL::CS::ComponentState|lib-NACL-CS-ComponentState-pm/fetch> for a
more detailed description along with a complete explanation of the options
it accepts.

Supports CMode CLI.

=over

=item Exceptions

=over

=item C<NACL::Exceptions::NoElementsFound>

When there are no elements matching the query specified or elements of that type
doesn't exist, then this exception will be thrown.

=back

=back

=cut

sub fetch {
    $Log->enter() if $may_enter;
    my $pkg        = shift;
    my @state_objs = $pkg->SUPER::fetch(
        @_,
	show_cmd => 'debug locks lock-sync show',
	choices => [
            {   method    => '_fetch_cmode_cli',
                interface => 'CLI',
                set       => 'CMode'
            }
        ],
        exception_text => 'No matching debug locks lock-sync(s) found',
    );
    $Log->exit() if $may_exit;
    return wantarray ? @state_objs : $state_objs[0];
}

sub _fetch_cmode_cli {
    $Log->enter() if $may_enter;
    my $pkg        = shift;
    my @state_objs = $pkg->SUPER::_fetch_cmode_cli(@_,
        api => 'debug_locks_lock_sync_show',);
    $Log->exit() if $may_exit;
    return @state_objs;
}

1;