org.ametys.odf.oai

Interface OaiSet

All Known Implementing Classes:

AbstractOaiSet

public interface OaiSet

Interface for OAI-PMH Sets

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROLE Avalon Role

Method Summary

Modifier and Type	Method and Description
I18nizableText	getDescription() Return the description of the set
I18nizableText	getName() Return the name of the set
AmetysObjectIterable<Program>	getRecords(Expression expression, SortCriteria sortCriteria) Retrieve the list of Records associated with this OAI Set

Field Detail

ROLE

static final String ROLE

Avalon Role

Method Detail

getName

I18nizableText getName()

Return the name of the set

Returns:

The name of the set. Can't be null.

getDescription

I18nizableText getDescription()

Return the description of the set

Returns:

The description of the set, or null if there is no description.

getRecords

AmetysObjectIterable<Program> getRecords(Expression expression,
                                         SortCriteria sortCriteria)

Retrieve the list of Records associated with this OAI Set

Parameters:

expression - An Expression to filter the list of records during the request

sortCriteria - A sort criteria to sort the result

Returns:

The list of Records