com.tle.mycontent.soap
Interface ScrapbookSoapService
Declaration: public interface ScrapbookSoapService

 

 

Methods Summary
abstract java.lang.String create(java.lang.String title, java.lang.String keywords, java.lang.String resourceType, java.lang.String filename, java.lang.String base64Data)
     Creates a new scrapbook item.
abstract boolean exists(java.lang.String itemUuid)
     Determine if scrapbook item with UUID of itemUuid exists
abstract java.lang.String search(java.lang.String query, java.lang.String[] resourceTypes, java.lang.String[] mimeTypes, int sortOrder, int offset, int length)
     Searches the current user's scrapbook content.
abstract java.lang.String update(java.lang.String itemUuid, java.lang.String title, java.lang.String keywords, java.lang.String filename, java.lang.String base64Data)
     Updates a current scrapbook item.

 

 

 

 

search

 

public abstract java.lang.String search( java.lang.String query,
java.lang.String[] resourceTypes,
java.lang.String[] mimeTypes,
int sortOrder,
int offset,
int length)

 

Searches the current user's scrapbook content. The XML returned is the same format as the searchItems method on SoapService41 Additionally each item has a node for:
content_type Either mypages or myresource
keywords Tags/keywords about the item

 

Parameters:
query-
A freetext query to search over the title and keywords properties.
resourceTypes-
Current options are "mypages" or "myresource". Set as null for all.
mimeTypes-
If "myresource" is selected you can filter the result by MIME type e.g. image/jpeg. Set as null for all.
sortOrder-
Can be one of: 0 - Ranking (search relevance), 1 - Date Modified, 2 - Name
offset-
The offset into the resultset you want to get results for.
length-
The max number of results returned with this query. Note that if you specify -1 the number of results will be unlimited.
Returns:
XML of the search results in the form of: 
 <results count="number of returned results">
    <available>number of total results obtainable</available>
    <result>
       Item XML
    </result>
    ...
 </results>
See the section on XML Formats in SOAP Services for the format of the returned Item XML.

 

 

 

create

 

public abstract java.lang.String create( java.lang.String title,
java.lang.String keywords,
java.lang.String resourceType,
java.lang.String filename,
java.lang.String base64Data)

 

Creates a new scrapbook item.

 

Parameters:
title-
The title of the item. Optional: if not supplied the filename will be used
keywords-
A comma seperated list of tags/keywords to associate with the item. Optional
resourceType-
Must be one of "mypages" or "myresource". Mandatory
filename-
The filename of the attachment. Mandatory
base64Data-
The data for the file. Mandatory
Returns:
The XML for the created item. See the section on XML Formats in SOAP Services

 

 

 

update

 

public abstract java.lang.String update( java.lang.String itemUuid,
java.lang.String title,
java.lang.String keywords,
java.lang.String filename,
java.lang.String base64Data)

 

Updates a current scrapbook item. Note: if you specify a filename and no base64data then the current attachment will be renamed.

 

Parameters:
itemUuid-
The uuid of the item to update. Mandatory
title-
The title of the item. Optional
keywords-
A comma seperated list of tags/keywords to associate with the item. Optional
filename-
Optional: if not supplied the current filename will be used.
base64Data-
Optional: if not supplied the current attachment data will be used.
Returns:
The XML for the created item. See the section on XML Formats in SOAP Services

 

 

 

exists

 

public abstract boolean exists( java.lang.String itemUuid)

 

Determine if scrapbook item with UUID of itemUuid exists

 

Parameters:
itemUuid-
The uuid of the item to find
Returns:
true if there is an existing item with this itemUuid.