org.mycore.services.webservices
Interface MCRWS

All Known Implementing Classes:

MCRWebService

public interface MCRWS

Method Summary

Document	MCRDoQuery(Document query) Search for MyCoRe objects
Document	MCRDoRetrieveClassification(String level, String type, String classID, String categID, String format) Retrieves MyCoRe Classification
Document	MCRDoRetrieveLinks(String from, String to, String type) Retrieves MyCoRe Links
Document	MCRDoRetrieveObject(String ID) Retrieves MyCoRe object

Method Detail

MCRDoRetrieveObject

Document MCRDoRetrieveObject(String ID)
                             throws Exception

Retrieves MyCoRe object

Parameters:

ID - The ID of the document to retrieve

Returns:

data of mycore object

Throws:

Exception

MCRDoRetrieveClassification

Document MCRDoRetrieveClassification(String level,
                                     String type,
                                     String classID,
                                     String categID,
                                     String format)
                                     throws Exception

Retrieves MyCoRe Classification

Parameters:

level - number of levels to retrievwe

type - parents|children

classID - The ID of the classification

categID - categroryID where retrieval with level starts

format - of retrieved classification, valid values are: editor['['formatAlias']']|metadata

Returns:

data of mycore classification

Throws:

Exception

MCRDoQuery

Document MCRDoQuery(Document query)
                    throws Exception

Search for MyCoRe objects

Parameters:

query - as mycore xml query

Returns:

resultset of search

Throws:

Exception

MCRDoRetrieveLinks

Document MCRDoRetrieveLinks(String from,
                            String to,
                            String type)
                            throws Exception

Retrieves MyCoRe Links

Parameters:

from - the source ID of the link

to - the target ID of the link

type - the link type (if it is null, refernce is default)

Returns:

mcr:result JDOM object

Throws:

Exception