CWIS Developer Documentation
Public Member Functions | List of all members
OAIItemFactory Interface Reference

Public Member Functions

 GetItem ($ItemId)
 Get an Item. More...
 
 GetItems ($StartingDate=NULL, $EndingDate=NULL)
 Get a list of items, optionally restricted by creation date. More...
 
 GetItemsInSet ($SetSpec, $StartingDate=NULL, $EndingDate=NULL)
 Get array of Items in a specified OAI set (if supported). More...
 
 GetListOfSets ()
 Get the list of supported OAI sets. More...
 
 SearchForItems ($SearchParams, $StartingDate=NULL, $EndingDate=NULL)
 Retrieve IDs of items that match search paramters when OAI-SQ is supported. More...
 

Detailed Description

Definition at line 10 of file OAIItemFactory.php.

Member Function Documentation

OAIItemFactory::GetItem (   $ItemId)

Get an Item.

Parameters
int$ItemIdItemId to fetch.
Returns
mixed Requested Items.
OAIItemFactory::GetItems (   $StartingDate = NULL,
  $EndingDate = NULL 
)

Get a list of items, optionally restricted by creation date.

Parameters
string$StartingDateStarting date for list (OPTIONAL).
string$EndingDateEnding date for list.
Returns
array Requested Items.
OAIItemFactory::GetItemsInSet (   $SetSpec,
  $StartingDate = NULL,
  $EndingDate = NULL 
)

Get array of Items in a specified OAI set (if supported).

Parameters
string$SetSpecOAI set specification.
string$StartingDateStarting date (OPTIONAL).
string$EndingDateEnding date (OPTIONAL).
Returns
array Requested items.
OAIItemFactory::GetListOfSets ( )

Get the list of supported OAI sets.

Returns
array of supported sets.
OAIItemFactory::SearchForItems (   $SearchParams,
  $StartingDate = NULL,
  $EndingDate = NULL 
)

Retrieve IDs of items that match search paramters when OAI-SQ is supported.

Parameters
mixed$SearchParamsSearch parameters to use.
mixed | null$StartingDateStarting date for search.
mixed | null$EndingDateEnding date for search.

The documentation for this interface was generated from the following file: