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

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

=head1 NAME

NACL::C::VserverLocksNfsv4

=head1 DESCRIPTION

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

=head1 ATTRIBUTES

=head2 command_interface

See L<NACL::C::Component::command_interface|lib-NACL-C-Component-pm/command_interface>

=head2 lock_uuid

=head2 vserver

=head2 vif

=head2 state_id

=head2 lif

=cut

package NACL::C::VserverLocksNfsv4;

use strict;
use warnings;

use NACL::CS::VserverLocksNfsv4;
use NACL::ComponentUtils qw (_optional_scalars);

use base 'NACL::C::Component::ONTAP';
use Params::Validate qw(validate validate_with SCALAR ARRAYREF);
use NATE::Log qw(log_global);
my $Log = log_global();
my $may_enter = $Log->may_enter();
my $may_exit  = $Log->may_exit();
use Data::Dumper;

=head1 METHODS

=head2 new

  my $VserverLocksNfsv4 = NACL::C::VserverLocksNfsv4->new(command_interface=>$ci,
                                   lock_uuid =>$lock_uuid,
                                   vserver =>$vserver,
                                   vif =>$vif,
                                   state_id =>$state_id,
                                   lif =>$lif,
								  );

Return a new VserverLocksNfsv4 component object with the given attributes.

=cut

use Class::MethodMaker [
    scalar => 'lock_uuid',
    scalar => 'vserver',
    scalar => 'vif',
    scalar => 'state_id',
    scalar => 'lif',
];

=head2 find

    my $VserverLocksNfsv4  = NACL::C::VserverLocksNfsv4->find(command_interface => $ci, ...);
	my @VserverLocksNfsv4s = NACL::C::VserverLocksNfsv4->find(command_interface => $ci, ...); 

(Class method)
A constructor of sorts, which discovers which elements are present (by
interacting with the given command interface).  In an array context it
creates a component object for each present element and returns them.
In a scalar context it creates a component object for just one
element.

This method is generally not implemented in individual components. The base
class (L<NACL::C::Component::ONTAP|lib-NACL-C-Component-ONTAP-pm> provides an implementation.
See <L<NACL::C::Component::find|lib-NACL-C-Component-pm/find> for a more
detailed description along with explanation of all the options accepted.

=head2 state

    my $VserverLocksNfsv4_state = $NACL::C::VserverLocksNfsv4->state();

(Instance method)
Fetch the current state of the element associated
with this component, and return a Component State object corresponding
to this component (calling this on NACL::C::VserverLocksNfsv4 would return 
a NACL::CS::VserverLocksNfsv4 object)

This method is generally not implemented in individual components. The base
class (L<NACL::C::Component::ONTAP|lib-NACL-C-Component-ONTAP-pm> provides an implementation.
See <L<NACL::C::Component::state|lib-NACL-C-Component-pm/state> for a more
detailed description along with explanation of all the options accepted.

=cut


__PACKAGE__->_load_event_class();

sub _primary_keys_validate_spec {
    return (
        'lock-uuid' => {type => SCALAR},
        'vserver'   => {type => SCALAR},
        'vif'       => {type => SCALAR},
        'state-id'  => {type => SCALAR},
        'lif'       => {type => SCALAR},
    );
} ## end sub _primary_keys_validate_spec

1;