|
⇤ ← Revision 1 as of 2008-11-07 12:10:59
Size: 113
Comment:
|
Size: 1743
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 5: | Line 5: |
| .. TODO .. | .. TODO: possibly more explanation .. == 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. 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. 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. |
Risearch API
A webservice which wraps the most common requests made to the resource index.
.. TODO: possibly more explanation ..
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.
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.
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.