Package com.lyncode.xoai.dataprovider.services.api

Interface ItemRepository

public interface ItemRepository

This class wraps the data source of items.

Version:

3.1.0

Method Summary

Modifier and Type	Method	Description
Item	getItem(String identifier)	Gets an item from the data source.
ListItemIdentifiersResult	getItemIdentifiers(List<ScopedFilter> filters, int offset, int length)	Gets a paged list of identifiers.
ListItemIdentifiersResult	getItemIdentifiers(List<ScopedFilter> filters, int offset, int length, String setSpec)	Gets a paged list of identifiers.
ListItemIdentifiersResult	getItemIdentifiers(List<ScopedFilter> filters, int offset, int length, String setSpec, Date from)	Gets a paged list of identifiers.
ListItemIdentifiersResult	getItemIdentifiers(List<ScopedFilter> filters, int offset, int length, String setSpec, Date from, Date until)	Gets a paged list of identifiers.
ListItemIdentifiersResult	getItemIdentifiers(List<ScopedFilter> filters, int offset, int length, Date from)	Gets a paged list of identifiers.
ListItemIdentifiersResult	getItemIdentifiers(List<ScopedFilter> filters, int offset, int length, Date from, Date until)	Gets a paged list of identifiers.
ListItemIdentifiersResult	getItemIdentifiersUntil(List<ScopedFilter> filters, int offset, int length, String setSpec, Date until)	Gets a paged list of identifiers.
ListItemIdentifiersResult	getItemIdentifiersUntil(List<ScopedFilter> filters, int offset, int length, Date until)	Gets a paged list of identifiers.
ListItemsResults	getItems(List<ScopedFilter> filters, int offset, int length)	Gets a paged list of items.
ListItemsResults	getItems(List<ScopedFilter> filters, int offset, int length, String setSpec)	Gets a paged list of items.
ListItemsResults	getItems(List<ScopedFilter> filters, int offset, int length, String setSpec, Date from)	Gets a paged list of items.
ListItemsResults	getItems(List<ScopedFilter> filters, int offset, int length, String setSpec, Date from, Date until)	Gets a paged list of items.
ListItemsResults	getItems(List<ScopedFilter> filters, int offset, int length, Date from)	Gets a paged list of items.
ListItemsResults	getItems(List<ScopedFilter> filters, int offset, int length, Date from, Date until)	Gets a paged list of items.
ListItemsResults	getItemsUntil(List<ScopedFilter> filters, int offset, int length, String setSpec, Date until)	Gets a paged list of items.
ListItemsResults	getItemsUntil(List<ScopedFilter> filters, int offset, int length, Date until)	Gets a paged list of items.

Method Detail

getItem

Item getItem(String identifier)
      throws IdDoesNotExistException,
             OAIException

Gets an item from the data source.

Parameters:

identifier - Unique identifier of the item

Returns:

ItemHelper

Throws:

IdDoesNotExistException

OAIException

getItemIdentifiers

ListItemIdentifiersResult getItemIdentifiers(List<ScopedFilter> filters,
                                             int offset,
                                             int length)
                                      throws OAIException

Gets a paged list of identifiers. The metadata prefix parameter is internally converted to a list of filters. That is, when configuring XOAI, it is possible to associate to each metadata format a list of filters.

Parameters:

offset - Start offset

length - Max items returned

Returns:

List of identifiers

Throws:

OAIException

getItemIdentifiers

ListItemIdentifiersResult getItemIdentifiers(List<ScopedFilter> filters,
                                             int offset,
                                             int length,
                                             Date from)
                                      throws OAIException

Gets a paged list of identifiers. The metadata prefix parameter is internally converted to a list of filters. That is, when configuring XOAI, it is possible to associate to each metadata format a list of filters.

Parameters:

offset - Start offset

length - Max items returned

from - Date parameter

Returns:

List of identifiers

Throws:

OAIException

getItemIdentifiersUntil

ListItemIdentifiersResult getItemIdentifiersUntil(List<ScopedFilter> filters,
                                                  int offset,
                                                  int length,
                                                  Date until)
                                           throws OAIException

Gets a paged list of identifiers. The metadata prefix parameter is internally converted to a list of filters. That is, when configuring XOAI, it is possible to associate to each metadata format a list of filters.

Parameters:

offset - Start offset

length - Max items returned

until - Date parameter

Returns:

List of identifiers

Throws:

OAIException

getItemIdentifiers

ListItemIdentifiersResult getItemIdentifiers(List<ScopedFilter> filters,
                                             int offset,
                                             int length,
                                             Date from,
                                             Date until)
                                      throws OAIException

Gets a paged list of identifiers. The metadata prefix parameter is internally converted to a list of filters. That is, when configuring XOAI, it is possible to associate to each metadata format a list of filters.

Parameters:

offset - Start offset

length - Max items returned

from - Date parameter

until - Date parameter

Returns:

List of identifiers

Throws:

OAIException

getItemIdentifiers

ListItemIdentifiersResult getItemIdentifiers(List<ScopedFilter> filters,
                                             int offset,
                                             int length,
                                             String setSpec)
                                      throws OAIException

Gets a paged list of identifiers. The metadata prefix parameter is internally converted to a list of filters. That is, when configuring XOAI, it is possible to associate to each metadata format a list of filters.

Parameters:

offset - Start offset

length - Max items returned

setSpec - Set Spec

Returns:

List of identifiers

Throws:

OAIException

getItemIdentifiers

ListItemIdentifiersResult getItemIdentifiers(List<ScopedFilter> filters,
                                             int offset,
                                             int length,
                                             String setSpec,
                                             Date from)
                                      throws OAIException

Gets a paged list of identifiers. The metadata prefix parameter is internally converted to a list of filters. That is, when configuring XOAI, it is possible to associate to each metadata format a list of filters.

Parameters:

offset - Start offset

length - Max items returned

setSpec - Set Spec

from - Date parameter

Returns:

List of identifiers

Throws:

OAIException

getItemIdentifiersUntil

ListItemIdentifiersResult getItemIdentifiersUntil(List<ScopedFilter> filters,
                                                  int offset,
                                                  int length,
                                                  String setSpec,
                                                  Date until)
                                           throws OAIException

Gets a paged list of identifiers. The metadata prefix parameter is internally converted to a list of filters. That is, when configuring XOAI, it is possible to associate to each metadata format a list of filters.

Parameters:

offset - Start offset

length - Max items returned

setSpec - Set Spec

until - Date parameter

Returns:

List of identifiers

Throws:

OAIException

getItemIdentifiers

ListItemIdentifiersResult getItemIdentifiers(List<ScopedFilter> filters,
                                             int offset,
                                             int length,
                                             String setSpec,
                                             Date from,
                                             Date until)
                                      throws OAIException

Gets a paged list of identifiers. The metadata prefix parameter is internally converted to a list of filters. That is, when configuring XOAI, it is possible to associate to each metadata format a list of filters.

Parameters:

offset - Start offset

length - Max items returned

setSpec - Set Spec

from - Date parameter

until - Date parameter

Returns:

List of identifiers

Throws:

OAIException

getItems

ListItemsResults getItems(List<ScopedFilter> filters,
                          int offset,
                          int length)
                   throws OAIException

Gets a paged list of items. The metadata prefix parameter is internally converted to a list of filters. That is, when configuring XOAI, it is possible to associate to each metadata format a list of filters.

Parameters:

offset - Start offset

length - Max items returned

Returns:

List of Items

Throws:

OAIException

getItems

ListItemsResults getItems(List<ScopedFilter> filters,
                          int offset,
                          int length,
                          Date from)
                   throws OAIException

Gets a paged list of items. The metadata prefix parameter is internally converted to a list of filters. That is, when configuring XOAI, it is possible to associate to each metadata format a list of filters.

Parameters:

offset - Start offset

length - Max items returned

from - Date parameter

Returns:

List of Items

Throws:

OAIException

getItemsUntil

ListItemsResults getItemsUntil(List<ScopedFilter> filters,
                               int offset,
                               int length,
                               Date until)
                        throws OAIException

Gets a paged list of items. The metadata prefix parameter is internally converted to a list of filters. That is, when configuring XOAI, it is possible to associate to each metadata format a list of filters.

Parameters:

offset - Start offset

length - Max items returned

until - Date parameter

Returns:

List of Items

Throws:

OAIException

getItems

ListItemsResults getItems(List<ScopedFilter> filters,
                          int offset,
                          int length,
                          Date from,
                          Date until)
                   throws OAIException

Gets a paged list of items. The metadata prefix parameter is internally converted to a list of filters. That is, when configuring XOAI, it is possible to associate to each metadata format a list of filters.

Parameters:

offset - Start offset

length - Max items returned

from - Date parameter

until - Date parameter

Returns:

List of Items

Throws:

OAIException

getItems

ListItemsResults getItems(List<ScopedFilter> filters,
                          int offset,
                          int length,
                          String setSpec)
                   throws OAIException

Gets a paged list of items. The metadata prefix parameter is internally converted to a list of filters. That is, when configuring XOAI, it is possible to associate to each metadata format a list of filters.

Parameters:

offset - Start offset

length - Max items returned

setSpec - Set spec

Returns:

List of Items

Throws:

OAIException

getItems

ListItemsResults getItems(List<ScopedFilter> filters,
                          int offset,
                          int length,
                          String setSpec,
                          Date from)
                   throws OAIException

Gets a paged list of items. The metadata prefix parameter is internally converted to a list of filters. That is, when configuring XOAI, it is possible to associate to each metadata format a list of filters.

Parameters:

offset - Start offset

length - Max items returned

from - Date parameter

setSpec - Set spec

Returns:

List of Items

Throws:

OAIException

getItemsUntil

ListItemsResults getItemsUntil(List<ScopedFilter> filters,
                               int offset,
                               int length,
                               String setSpec,
                               Date until)
                        throws OAIException

Gets a paged list of items. The metadata prefix parameter is internally converted to a list of filters. That is, when configuring XOAI, it is possible to associate to each metadata format a list of filters.

Parameters:

offset - Start offset

length - Max items returned

until - Date parameter

setSpec - Set spec

Returns:

List of Items

Throws:

OAIException

getItems

ListItemsResults getItems(List<ScopedFilter> filters,
                          int offset,
                          int length,
                          String setSpec,
                          Date from,
                          Date until)
                   throws OAIException

Gets a paged list of items. The metadata prefix parameter is internally converted to a list of filters. That is, when configuring XOAI, it is possible to associate to each metadata format a list of filters.

Parameters:

offset - Start offset

length - Max items returned

from - Date parameter

until - Date parameter

setSpec - Set spec

Returns:

List of Items

Throws:

OAIException