Difference between revisions of "API:EPrints/NamedSet"

From EPrints Documentation
Jump to: navigation, search
(Created page with '<!-- Pod2Wiki=_preamble_ This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' com…')
 
Line 1: Line 1:
 
<!-- Pod2Wiki=_preamble_  
 
<!-- Pod2Wiki=_preamble_  
 
This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
 
This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
  -->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/NamedSet.pm|package_name=EPrints::NamedSet}}[[Category:API|NAMEDSET]][[Category:API:EPrints/NamedSet|NAMEDSET]]<div><!-- Edit below this comment -->
+
  -->{{API}}{{Pod2Wiki}}{{API:Source|file=perl_lib/EPrints/NamedSet.pm|package_name=EPrints::NamedSet}}[[Category:API|NAMEDSET]][[Category:API:EPrints/NamedSet|NAMEDSET]]<div><!-- Edit below this comment -->
  
  

Revision as of 15:26, 16 December 2011

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


API: Core API

Latest Source Code (3.3, 3.2) | Revision Log | Before editing this page please read Pod2Wiki


NAME

EPrints::NamedSet - Repository Configuration

User Comments


SYNOPSIS

 $namedset = EPrints::NamedSet->new( "eprint",
   repository => $repository
 );
 
 $namedset->add_option( "performance", "my_package" );
 $namedset->remove_option( "thesis", "my_package" );
 

User Comments


DESCRIPTION

A utility class to manipulate named sets. Add and remove methods are designed to be called by Bazaar Packages

User Comments


METHODS

User Comments


new

$namedset = EPrints::NamedSet->new( $id, %opts )

User Comments


add_option

$nameset->add_option( $option, $package_name [, $index] )

Add an option to the named set.

If the option already exists and is not core or already beloning to this package then a required_by field is added to the file.

If it already exists, index is ignored.

User Comments


remove_option

$namedset->remove_option( $option, $package_name )

Remove an option from the named set.

User Comments


remove

$ok = $namedset->remove

Remove the namedset from the file system.

User Comments


COPYRIGHT

User Comments