= Risearch API =

A webservice which wraps the most common requests made to the resource index.



== Risearch API ==

WSDL: [[attachment:DomsResourceIndex.xml]]

The following describes those methods of the Risearch API that may be called by the GUI.

==== allReferencingTheseObjects ====
Find the objects that have some relation to one of the objects given and is not deleted.

Input parameters:
 * {{{String[] objects}}} A list of pids of objects.
 * {{{String user}}} The username for the fedora server.
 * {{{String pass}}} The password for the username.

Returns:
 * {{{DigitalObject[]}}} The objects that have a relation to these objects. Data structure summarized below.

Throws:
 * {{{Exception}}} If something went wrong.



==== allTemplatesInCollectionForContentModel ====
Finds the object that are templates in the given collection for the specified content model, and are not deleted.

Input parameters:
 * {{{String collection}}} The collection the templates should be in.
 * {{{String contentModel}}} The content model they should be templates for.
 * {{{String user}}} The username for the fedora server.
 * {{{String pass}}} The password for the username.

Returns:
 * {{{DigitalObject[]}}} The list of templates. Data structure summarized below.

Throws:
 * {{{Exception}}} If something went wrong.



==== getState ====
Syntactic sugar method for getting the state of an Fedora object.

Input parameters:
 * {{{String pid}}} The pid of the object to examine.
 * {{{String user}}} The username for the fedora server.
 * {{{String pass}}} The password for the username.

Returns:
 * {{{String}}} The state as a string. Could be "A", "I" or "D".

Throws:
 * {{{Exception}}} If something went wrong.




=== Data structures ===

==== DigitalObject ====
Returned by allReferencingTheseObjects and allTemplatesInCollectionForContentModel.

Contains the following private fields. Each has corresponding getter and setter methods.

 * {{{String}}} title
 * {{{String}}} pid