# $Id$

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

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

=head1 NAME

NACL::CS::DebugCrsQueue

=head1 DESCRIPTION

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

=head1 ATTRIBUTES

The individual pieces of data that are part of the state of the DebugCrsQueue
element are the attributes of the DebugCrsQueue 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<< message_type >>

Message Type possible value(s) are, baseline,marker,update

Filled in for CMode CLI

=item C<< stream_uuid >>

Stream UUID

Filled in for CMode CLI

=item C<< path_to_message >>

Reference to Actual Message

Filled in for CMode CLI

=item C<< message_seq_num_in_queue >>

Sequence Number of Message in Queue

Filled in for CMode CLI

=item C<< row >>

Update or Marker

Filled in for CMode CLI.

=item C<< deleted >>

Deleted from Active Queue possible value(s) are, true,false

Filled in for CMode CLI.

=item C<< source_cluster_seq_num >>

Cluster Sequence Number on Source

Filled in for CMode CLI.


=back

=cut

package NACL::CS::DebugCrsQueue;

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 => 'message_type',
    scalar => 'stream_uuid',
    scalar => 'path_to_message',
    scalar => 'message_seq_num_in_queue',
    scalar => 'row',
    scalar => 'deleted',
    scalar => 'source_cluster_seq_num',
];

=head1 METHODS

=head2 fetch

    my $DebugCrsQueue_state  = NACL::CS::DebugCrsQueue->fetch(command_interface => $ci, ...);
	my @DebugCrsQueue_states = NACL::CS::DebugCrsQueue->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.

Uses 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, @args) = @_;
    my @state_objs = $pkg->SUPER::fetch(
        @args,
	show_cmd => 'debug crs queue show',
	choices => [
            {   method    => '_fetch_cmode_cli',
                interface => 'CLI',
                set       => 'CMode'
            }
        ],
        exception_text => 'No matching debug crs queue(s) found',
        frontend       => 'NACL::CS::DebugCrsQueue::fetch',
    );
    $Log->exit() if $may_exit;
    return wantarray ? @state_objs : $state_objs[0];
}

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

1;