The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Slurm-Sacctmgr-1.1.0
River stage zero No dependents
/ Slurm::Sacctmgr::EntityBaseListable

NAME

Slurm::Sacctmgr::EntityBaseListable

SYNOPSIS

  package Slurm::Sacctmgr::Association;
  use base qw(Slurm::Sacctmgr::EntityBaseListable);

  sub _ro_fields($)
  {     my $class = shift;
        return qw( account description organization coordinators);
  }

  ...

DESCRIPTION

This is the base class for entities managed by sacctmgr, for entities which can be listed with the "list" or "show" commands. It provides the sacctmgr_list method. The heavy liting is actually done by Slurm::Sacctmgr::EntityBase.

See Slurm::Sacctmgr::EntityBase for definitions of:

_ro_fields
_rw_fields
_required_fields
_sacctmgr_fields_in_order
_sacctmgr_entity_name
_my_sacctmgr_where_clause
_sacctmgr_name_field

This module defines

_data_converter_csv

Used for converting CSV output from sacctmgr list commands to list refs.

_sacctmgr_list_cmd($sacctmgr)

The sacctmgr list command to list entities of this type. Requires a Slurm::Sacctmgr instance because may depend on version of sacctmgr being used. Default is "list $entity format=$fmtstr" where $entity is _sacctmgr_entity_name and $fmtstr is the comma separated concatenation of the field names in _sacctmgr_fields_in_order

new_from_sacctmgr_list_record($rec)

This is an alternative constructor, which takes a list ref e.g. from one of the list returned by a Slurm::Sacctmgr::run_generic_sacctmgr_list_command and returns a new instance of specified type. Elements of list are required to be in the order given by _sacctmgr_fields_in_order.

sacctmgr_list($sacctmgr, [ where=>val, [where2=>val2 ... ])

This calls Slurm::Sacctmgr::run_generic_list_command to list the entities of our type. Optional where clauses given as key => value pairs can be given, otherwise it should list all entities. The returned list is converted to a list of Perl objects of the appropriate type. On error, a non-ref error string is returned.

sacctmgr_list_me($sacctmgr)

This is an instance method, and calls sacctmgr_list with the appropriate where clause to return only the record representing the current instance. This is returned as a new instance. If no matching record found, returns undef. On error, a non-ref error string is returned.

new_from_sacctmgr_by_name($sacctmgr, $name)

Returns a new instance of the Perl object for given entity type, obtained from looking up in sacctmgr for the record with the given name. If no such record found, returns undef. Returns non-ref true value (error message) on error. Otherwise, returns the instance.

EXPORT

Nothing. Pure OO interface.

SEE ALSO

EntityBase

AUTHOR

Tom Payerle, payerle@umd.edu

COPYRIGHT AND LICENSE

Copyright (C) 2014-2016 by the University of Maryland.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.