SoapService50 (EQUELLA SOAP API)

com.tle.web.remoting.soap
Interface SoapService50

Declaration:

public interface SoapService50

Methods Summary
abstract java.lang.String	acceptTask(java.lang.String itemUuid, int itemVersion, java.lang.String taskId, boolean unlock) Accept the moderation task for the given item.
abstract void	addComment(java.lang.String itemUuid, int itemVersion, java.lang.String commentText, int rating, boolean anonymous) Add a new comment to an item.
abstract void	addGroup(java.lang.String groupId, java.lang.String groupName) Adds an internal EQUELLA group with the given groupId and groupName to the server.
abstract void	addSharedOwner(java.lang.String itemUuid, int itemVersion, java.lang.String userId) Adds a shared owner to an item
abstract java.lang.String	addUser(java.lang.String userId, java.lang.String username, java.lang.String password, java.lang.String firstName, java.lang.String lastName, java.lang.String email) Creates an internal EQUELLA user on the server.
abstract void	addUserToGroup(java.lang.String userId, java.lang.String groupId) Adds the user (external or internal) with the id of userId to the internal EQUELLA group with the id of groupId.
abstract void	archiveItem(java.lang.String itemUuid, int itemVersion) Archives an item.
abstract void	cancelItemEdit(java.lang.String itemUuid, int itemVersion) Cancel the editing of a previous `editItem` or `newItem` call.
abstract java.lang.String	cloneItem(java.lang.String itemUuid, int itemVersion, boolean copyAttachments) Creates a clone of an existing item.
abstract void	deleteComment(java.lang.String itemUuid, int itemVersion, java.lang.String commentUuid) Delete a single comment for an item by ID.
abstract void	deleteFile(java.lang.String stagingId, java.lang.String filename) Deletes an attachment from a staging area.
abstract void	deleteGroup(java.lang.String groupId) Deletes an internal EQUELLA group with the given groupId.
abstract void	deleteItem(java.lang.String itemUuid, int itemVersion) Delete an item.
abstract void	deleteUser(java.lang.String userId) Deletes the user from the EQUELLA server.
abstract java.lang.String	editItem(java.lang.String itemUuid, int itemVersion, boolean modifyingAttachments) Edit an existing item.
abstract java.lang.String	editUser(java.lang.String userId, java.lang.String username, java.lang.String password, java.lang.String firstName, java.lang.String lastName, java.lang.String email) Update the user on the server with the modifications made to the user.
abstract java.lang.String	facetCount(java.lang.String freetext, java.lang.String[] collectionUuids, java.lang.String whereClause, java.lang.String[] facetXpaths) Identical to `queryCount` but allows for multiple where clauses to be passed, and an array of respective counts to be returned.
abstract java.lang.String	getCollection(java.lang.String collectionUuid)
abstract java.lang.String	getComment(java.lang.String itemUuid, int itemVersion, java.lang.String commentUuid) Retrieve a single comment for an item by ID.
abstract java.lang.String	getComments(java.lang.String itemUuid, int itemVersion, int filter, int order, int limit) Retrieve several comments for an item.
abstract java.lang.String	getContributableCollections() Returns a list of all collections that the currently logged in user can contribute to.
abstract java.lang.String	getGroupUuidForName(java.lang.String groupName) Find the id of the internal EQUELLA group with the name of groupName.
abstract java.lang.String	getItem(java.lang.String itemUuid, int itemVersion, java.lang.String select) Retrieves the XML for an item.
abstract java.lang.String[]	getItemFilenames(java.lang.String itemUuid, int itemVersion, java.lang.String path, boolean system) A list of all the files stored with an item.
abstract java.lang.String	getSchema(java.lang.String schemaUuid)
abstract java.lang.String	getSearchableCollections() Returns a list of all collections that the currently logged in user can specifically choose for searching.
abstract java.lang.String	getTaskFilterCounts(boolean ignoreZero)
abstract java.lang.String[]	getTaskFilterNames()
abstract java.lang.String	getTaskList(java.lang.String filterName, int start, int numResults)
abstract java.lang.String	getUser(java.lang.String userId) Retrieves an internal EQUELLA user with the id of userId.
abstract boolean	groupExists(java.lang.String groupId) Determine if the internal EQUELLA group with the id of groupId exists.
abstract boolean	isUserInGroup(java.lang.String userId, java.lang.String groupId) Is the user (external or internal) with id of userId directly in (that is, not in a subgroup of) the internal EQUELLA group with the id of groupId.
abstract boolean	itemExists(java.lang.String itemUuid, int itemVersion) Determines if there is an existing item with the supplied itemUuid and itemVersion
abstract void	keepAlive() This is a light-weight method that can be invoked periodically to ensure that the current session does not timeout.
abstract java.lang.String	login(java.lang.String username, java.lang.String password)
abstract java.lang.String	loginWithToken(java.lang.String token) Login with the given token.
abstract void	logout() Stops the currently logged in user's session on the server.
abstract java.lang.String	newItem(java.lang.String collectionUuid) Creates an item in the collection with the id of collectionId for you to begin editing with.
abstract java.lang.String	newVersionItem(java.lang.String itemUuid, int itemVersion, boolean copyAttachments) Creates a new version of an existing item.
abstract int	queryCount(java.lang.String[] collectionUuids, java.lang.String where) Counts the number of items for the given collection definition and where clause.
abstract int[]	queryCounts(java.lang.String[] collectionUuids, java.lang.String[] wheres) Identical to `queryCount` but allows for multiple where clauses to be passed, and an array of respective counts to be returned.
abstract java.lang.String	rejectTask(java.lang.String itemUuid, int itemVersion, java.lang.String taskId, java.lang.String rejectMessage, java.lang.String toStepId, boolean unlock) Reject the moderation task for the given item.
abstract void	removeAllUsersFromGroup(java.lang.String groupId) Removes all the users (internal and external) from the internal EQUELLA group with id of groupId.
abstract void	removeSharedOwner(java.lang.String itemUuid, int itemVersion, java.lang.String userId) Removes a shared owner from an item
abstract void	removeUserFromAllGroups(java.lang.String userId) Remove the user (external or internal) with the id of userId from all internal EQUELLA groups.
abstract void	removeUserFromGroup(java.lang.String userId, java.lang.String groupId) Remove the user (external or internal) with the id of userId from the internal EQUELLA group with the id of groupId.
abstract java.lang.String	saveItem(java.lang.String itemXML, boolean submit) Save changes made to an item which also unlocks the item.
abstract java.lang.String	searchItems(java.lang.String freetext, java.lang.String[] collectionUuids, java.lang.String whereClause, boolean onlyLive, int orderType, boolean reverseOrder, int offset, int length) Search for items that the current user can discover.
abstract java.lang.String	searchItemsFast(java.lang.String freetext, java.lang.String[] collectionUuids, java.lang.String whereClause, boolean onlyLive, int orderType, boolean reverseOrder, int offset, int length, java.lang.String[] resultCategories) Similar to searchItems but with two big differences: a) it is much faster, and b) it does not return results in the standard item XML format.
abstract void	setOwner(java.lang.String itemUuid, int itemVersion, java.lang.String userId) Re-assigns ownership of an item
abstract void	unlock(java.lang.String itemUuid, int itemVersion) Force the unlocking of an item (must be the owner of the lock).
abstract void	unzipFile(java.lang.String stagingId, java.lang.String zipfile, java.lang.String outpath) Unzip a zip file that has been uploaded to the staging area.
abstract void	uploadFile(java.lang.String stagingId, java.lang.String filename, java.lang.String base64Data, boolean overwrite) Upload a file into the staging area.
abstract boolean	userExists(java.lang.String userId) Determine if the internal EQUELLA user with the id of userId exists.
abstract boolean	userNameExists(java.lang.String username) Determine if the internal EQUELLA user with the login name of username exists.

public abstract java.lang.String login(

java.lang.String username,
java.lang.String password)

loginWithToken

public abstract java.lang.String loginWithToken(

java.lang.String token)

Note that the response sent back by this method will include a new cookie. Your client MUST have cookies enabled.

Parameters:
token	-	Token string

Returns:
The user XML. See the section on XML Formats in `SOAP Services`

Throws:
An - exception is thrown if login fails for any reason (e.g. invalid credentials)

logout

public abstract void logout(

)

Stops the currently logged in user's session on the server. After calling Logout, you must call Login again to use any other methods on the interface.

keepAlive

public abstract void keepAlive(

)

This is a light-weight method that can be invoked periodically to ensure that the current session does not timeout.

newItem

public abstract java.lang.String newItem(

java.lang.String collectionUuid)

Creates an item in the collection with the id of collectionId for you to begin editing with. Note that this will not create an item on the server until you call the saveItem method. The item XML will be initialised with a new UUID and a new staging ID where attachments can be uploaded to.

Parameters:
collectionUuid	-	The UUID of the collection the item will be contributed to.

Returns:
The XML for the new item that you can edit. See the section on XML Formats in `SOAP Services`

editItem

public abstract java.lang.String editItem(

java.lang.String itemUuid,
int itemVersion,
boolean modifyingAttachments)

Edit an existing item. The item will be locked for editing and attachments copied to a staging folder if requested by the modifyingAttachments parameter. You must call saveItem to commit your changes.

Parameters:
itemUuid	-	The UUID of the item.
itemVersion	-	The version of the item.
modifyingAttachments	-	Specify true if you want to edit the attached files for this item. If false is specified a performance improvement is gained as the attachments are not copied to the staging area.

Returns:
The XML for the item that you can edit. See the section on XML Formats in `SOAP Services`

saveItem

public abstract java.lang.String saveItem(

java.lang.String itemXML,
boolean submit)

Save changes made to an item which also unlocks the item. Before calling this, you must either use editItem or newItem and use the XML returned by these methods to pass in as the itemXML parameter.

Parameters:
itemXML	-	The item's XML retrieved from `editItem` or `newItem`, plus any of your modifications.
submit	-	If true, submit the item for moderation. If false, the item will stay in draft status.

newVersionItem

public abstract java.lang.String newVersionItem(

java.lang.String itemUuid,
int itemVersion,
boolean copyAttachments)

Creates a new version of an existing item. The item will be locked for editing and attachments copied to a staging folder if requested by the modifyingAttachments parameter. You must call saveItem to commit your changes.

Parameters:
itemUuid	-	The UUID of the original item to create a new version of.
itemVersion	-	The version of the original item to create a new version of.
copyAttachments	-	Include the attachments of the original item with the new version

Returns:
The XML for the item that you can edit. See the section on XML Formats in `SOAP Services`

cloneItem

public abstract java.lang.String cloneItem(

java.lang.String itemUuid,
int itemVersion,
boolean copyAttachments)

Creates a clone of an existing item. The item will be locked for editing and attachments copied to a staging folder if requested by the modifyingAttachments parameter. You must call saveItem to commit your changes.

Parameters:
itemUuid	-	The UUID of the original item to create a clone of.
itemVersion	-	The version of the original item to create a clone of.
copyAttachments	-	Include the attachments of the original item with the new version.

Returns:
The XML for the item that you can edit. See the section on XML Formats in `SOAP Services`

archiveItem

public abstract void archiveItem(

java.lang.String itemUuid,
int itemVersion)

Archives an item. Will not delete the item if it is already archived.

Parameters:
itemUuid	-	The UUID of the item to archive.
itemVersion	-	The version of the item to archive.

cancelItemEdit

public abstract void cancelItemEdit(

java.lang.String itemUuid,
int itemVersion)

Cancel the editing of a previous editItem or newItem call. This will unlock the item and remove any temporary files.

Parameters:
itemUuid	-	The UUID of the item.
itemVersion	-	The version of the item.

unlock

public abstract void unlock(

java.lang.String itemUuid,
int itemVersion)

Force the unlocking of an item (must be the owner of the lock).

Parameters:
itemUuid	-	The UUID of the item.
itemVersion	-	The version of the item.

deleteItem

public abstract void deleteItem(

java.lang.String itemUuid,
int itemVersion)

Delete an item. This will set the status of the item to 'deleted' OR it will purge the item from the system completely if the item has already been set to 'deleted'

Parameters:
itemUuid	-	the uuid of the item.
itemVersion	-	the version of the item.

uploadFile

public abstract void uploadFile(

java.lang.String stagingId,
java.lang.String filename,
java.lang.String base64Data,
boolean overwrite)

Upload a file into the staging area. Note that this does not attach the file to your item! To link the file to the item you need to add an attachment node to the item XML. See the section on XML Formats in SOAP Services for the location and format of the attachment XML.

Parameters:
stagingId	-	The ID of the staging area. This can be retrieved from the XML returned by `newItem` or `editItem`.
filename	-	the name of the file to upload the data to, relative to the item's directory
base64Data	-	file bytes as a base64 encoded String.
overwrite	-	Replace the current file with the same filename if there is any. If you specify false, the existing file will be appended to. This is useful (and advisable for large files) for uploading files in manageable chunks.

deleteFile

public abstract void deleteFile(

java.lang.String stagingId,
java.lang.String filename)

Deletes an attachment from a staging area. Note that this does not remove the link to the file from your item if there is an existing link to the file! To remove the link to the file on the item (if there is one) you need to remove the appropriate attachment node from the item XML. See the section on XML Formats in SOAP Services for the location and format of the attachment XML.

Parameters:
stagingId	-	The ID of the staging area. This can be retrieved from the XML returned by `newItem` or `editItem`.
filename	-	The name of the file to delete from the staging area, relative to the item's directory

unzipFile

public abstract void unzipFile(

java.lang.String stagingId,
java.lang.String zipfile,
java.lang.String outpath)

Unzip a zip file that has been uploaded to the staging area.

Parameters:
stagingId	-	The ID of the staging area. This can be retrieved from the XML returned by `newItem` or `editItem`.
zipfile	-	The filename of the zip file, relative to the item's directory e.g. "myzips/zipfile.zip"
outpath	-	The directory the zip contents should be output to, relative to the item's directory e.g. "unzipped/zipfile"

searchItems

public abstract java.lang.String searchItems(

java.lang.String freetext,
java.lang.String[] collectionUuids,
java.lang.String whereClause,
boolean onlyLive,
int orderType,
boolean reverseOrder,
int offset,
int length)

Search for items that the current user can discover.

Parameters:
freetext	-	A freetext query. If null is specified, '*' is used
collectionUuids	-	An array of collections UUIDs to restrict results to. If null or empty, all collections are searched.
whereClause	-	The format for the where clause is: WHERE STATEMENT ::= "where"? BOOLEAN_EXPR BOOLEAN_EXPR ::= OR_BOOLEAN_EXPR OR_BOOLEAN_EXPR ::= AND_BOOLEAN_EXPR ("or" AND_BOOLEAN_EXPR)* AND_BOOLEAN_EXPR ::= CLAUSE ("and" CLAUSE)* CLAUSE ::= "not" CLAUSE \| BRACKETS \| COMPARISON \| EXISTS_CLAUSE BRACKETS ::= "(" BOOLEAN_EXPR ")" COMPARISON ::= XPATH COMPARISON_OP COMPARISON_RHS EXISTS_CLAUSE ::= XPATH "exists" XPATH ::= "/" (ALPHA \| NUMBER \| [/._:@])+ COMPARISON_OP ::= "=" \| "is" \| "<>" \| "is not" \| "<" \| "<=" \| ">" \| ">=" \| "like" \| "not like" \| "in" \| "not in" COMPARISON_RHS ::= "null" \| NUMBER_VALUE \| STRING_VALUE \| GROUP_VALUE STRING_VALUE ::= "'" STRING "'" NUMBER_VALUE ::= NUMBER+ GROUP_VALUE ::= "(" STRING_VALUE ("," STRING_VALUE)* ")" STRING ::= (ALPHA \| [0-9] \| ...)* ALPHA ::= [a-zA-Z] NUMBER ::= [0-9] For example, `where /xml/item/name not like 'hello%'`. Note that any schema node you search on in the where clause must have "Index for Advanced Searches" selected.
onlyLive	-	Return only items with a status of Live (e.g. not Draft)
orderType	-	Can be one of: 0 - Ranking (search relevance), 1 - Date Modified, 2 - Name, 4 - Rating
reverseOrder	-	Specify true to reverse the order specified in orderType
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 capped at 50.

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.

searchItemsFast

public abstract java.lang.String searchItemsFast(

java.lang.String freetext,
java.lang.String[] collectionUuids,
java.lang.String whereClause,
boolean onlyLive,
int orderType,
boolean reverseOrder,
int offset,
int length,
java.lang.String[] resultCategories)

Similar to searchItems but with two big differences: a) it is much faster, and b) it does not return results in the standard item XML format. All parameters are identical to searchItems unless indicated below.

Parameters:
length	-	Same as searchItems, but restricted to a max of 50.
resultCategories	-	indicates which groups of information should be returned for each result. Valid options are 'basic' to return the name and description, 'metadata' to return the items metadata, or blank to only return the uuid and version.

queryCount

public abstract int queryCount(

java.lang.String[] collectionUuids,
java.lang.String where)

Counts the number of items for the given collection definition and where clause.

Parameters:
collectionUuids	-	An array of collection definition UUIDs.
where	-	A where clause. Can be blank. See searchItems for the format of the where clauses.

Returns:
The number of items that were counted.

queryCounts

public abstract int[] queryCounts(

java.lang.String[] collectionUuids,
java.lang.String[] wheres)

Identical to queryCount but allows for multiple where clauses to be passed, and an array of respective counts to be returned.

Parameters:
collectionUuids	-	An array of collection definition UUIDs.
wheres	-	An array of where clauses. See searchItems for the format of the where clause.

Returns:
The number of items that were counted.

facetCount

public abstract java.lang.String facetCount(	java.lang.String freetext, java.lang.String[] collectionUuids, java.lang.String whereClause, java.lang.String[] facetXpaths)
throws	java.lang.Exception

Identical to queryCount but allows for multiple where clauses to be passed, and an array of respective counts to be returned.

Parameters:
freetext	-	A freetext query. If null is specified, '*' is used.
collectionUuids	-	An array of collection definition UUIDs.
facetXpaths	-	the XPaths of each facet to return a count for.
orderType	-	A where clause. See searchItems for the format of the where clause.

Returns:

The values and count of matching items for each facet. It is returned in the following XML form:

 <facets>
     <facet xpath="/xml/item/mediatype">
         <value count="52">animation</value>
         <value count="8">audio</value>
         <value count="11">image</value>
         ...
     </facet>
     <facet xpath="/xml/item/classification/learningarea">
         ...
     </facet>
     ...
 </facets>

getItem

public abstract java.lang.String getItem(

java.lang.String itemUuid,
int itemVersion,
java.lang.String select)

Retrieves the XML for an item. Note that the item XML returned from this method is unfit for editing, that is, you cannot call saveItem on it. You should call editItem if you wish to edit and save the item XML. See the section on XML Formats in SOAP Services

Parameters:
itemUuid	-	UUID of the item to retrieve.
itemVersion	-	The version of the item to retrieve. A version of 0 will retrieve the latest version.
select	-	Currently not functional

Returns:
A string representation of the item XML. See the section on XML Formats in `SOAP Services`

getSearchableCollections

public abstract java.lang.String getSearchableCollections(

)

Returns a list of all collections that the currently logged in user can specifically choose for searching.

 <xml>
   Collection XML
   ...
 </xml>

See the section on XML Formats in SOAP Services for the format of the returned Collection XML.

Returns:
The xml for the enumeration

getContributableCollections

public abstract java.lang.String getContributableCollections(

)

Returns a list of all collections that the currently logged in user can contribute to.

 <xml>
   Collection XML
   ...
 </xml>

See the section on XML Formats in SOAP Services for the format of the returned Collection XML.

Returns:
The xml for the enumeration

setOwner

public abstract void setOwner(

java.lang.String itemUuid,
int itemVersion,
java.lang.String userId)

Re-assigns ownership of an item

Parameters:
itemUuid	-	The UUID of item to change the owner of
itemVersion	-	The version of the item to change to owner of
userId	-	The unique ID of the user to make the new owner

addSharedOwner

public abstract void addSharedOwner(

java.lang.String itemUuid,
int itemVersion,
java.lang.String userId)

Adds a shared owner to an item

Parameters:
itemUuid	-	The UUID of item to add a shared owner to
itemVersion	-	The version of the item to change to add a shared owner to
userId	-	The unique ID of the user to add as a shared owner

removeSharedOwner

public abstract void removeSharedOwner(

java.lang.String itemUuid,
int itemVersion,
java.lang.String userId)

Removes a shared owner from an item

Parameters:
itemUuid	-	The UUID of item to remove a shared owner from
itemVersion	-	The version of the item to remove a shared owner from
userId	-	The unique ID of the user to remove as a shared owner

acceptTask

public abstract java.lang.String acceptTask(

java.lang.String itemUuid,
int itemVersion,
java.lang.String taskId,
boolean unlock)

Accept the moderation task for the given item.

Parameters:
itemUuid	-	The UUID of the item.
itemVersion	-	The version of the item.
taskId	-	The UUID of the task to accept.
unlock	-	Whether or not to unlock the item after accepting.

Returns:
The unique ID of the task that was accepted.

Throws:
java.lang.Exception -

rejectTask

public abstract java.lang.String rejectTask(

java.lang.String itemUuid,
int itemVersion,
java.lang.String taskId,
java.lang.String rejectMessage,
java.lang.String toStepId,
boolean unlock)

Reject the moderation task for the given item.

Parameters:
itemUuid	-	The UUID of the item.
itemVersion	-	The version of the item.
taskId	-	The UUID of the task to reject.
rejectMessage	-	The rejection reason.
toStepId	-	The UUID of the task to reject back to.
unlock	-	Whether or not to unlock the item after accepting.

Returns:
The UUID of the task that was rejected.

Throws:
java.lang.Exception -

getSchema

public abstract java.lang.String getSchema(

java.lang.String schemaUuid)

Parameters:
schemaUuid	-	The unique ID of the schema

Returns:
XML of format: <tasks> Schema XML ... </tasks> See the section on XML Formats in `SOAP Services` for the format of the Schema XML

Throws:
java.lang.Exception -

getCollection

public abstract java.lang.String getCollection(

java.lang.String collectionUuid)

Parameters:
collectionUuid	-	The unique ID of the collection

Returns:
XML of format: <tasks> Collection XML ... </tasks> See the section on XML Formats in `SOAP Services` for the format of the Collection XML

Throws:
java.lang.Exception -

getComment

public abstract java.lang.String getComment(

java.lang.String itemUuid,
int itemVersion,
java.lang.String commentUuid)

Retrieve a single comment for an item by ID.

Parameters:
itemUuid	-	UUID of the item.
itemVersion	-	Version of the item.
commentUuid	-	UUID of the comment to retrieve.

Returns:

XML of format:

 <comment>
     <uuid>...         Identifier for comment on this item
     <rating>...       Non-existent for no rating else a value between 1 and 5 inclusive
     <text>...         Non-existent for no comment, else the comment text made by the user
     <owner>...        ID of user writing this thread.  Empty for guest or anonymous comments/ratings.
     <dateCreated>...  Full ISO format including time zone, eg, 2011-02-09T10:53:23+1000
 </comment>

getComments

public abstract java.lang.String getComments(

java.lang.String itemUuid,
int itemVersion,
int filter,
int order,
int limit)

Retrieve several comments for an item.

Parameters:
itemUuid	-	UUID of the item.
itemVersion	-	Version of the item.
filter	-	Bit-mask indicating what filters, if any, to apply to the results. A value of zero indicates no filtering. 1 Must have non-empty comment text 2 Must have a rating 4 Comment/rating must be from a known user, not from a guest session or comment marked as anonymous 8 Only the most recent comment/rating per user For example, '9' would only return the most recent non-empty comment per user.
order	-	Integer indicating the order of results returned: 1 to order by most recent (reverse chronological) 2 to order by earliest (chronological) 3 to order by highest rating 4 for lowest rating
limit	-	Integer indicating the maximum number of comments to return. A value of zero or less will return all comments.

Returns:
XML of format: <comments average="3.5"> Current average rating for the item. -1 no ratings. <comment>... See return XML on getComment() <comment>... ... </comments>

addComment

public abstract void addComment(

java.lang.String itemUuid,
int itemVersion,
java.lang.String commentText,
int rating,
boolean anonymous)

Add a new comment to an item.

Parameters:
itemUuid	-	UUID of the item.
itemVersion	-	Version of the item.
commentText	-	Comment text to add. Blank if only a rating.
rating	-	Integer where 0 indicates no rating, other wise between 1 and 5 inclusive.
anonymous	-	true if the identify of the comment author should be hidden when comments are being viewed. The author user ID is still recorded for auditing purposes.

deleteComment

public abstract void deleteComment(

java.lang.String itemUuid,
int itemVersion,
java.lang.String commentUuid)

Delete a single comment for an item by ID.

Parameters:
itemUuid	-	UUID of the item.
itemVersion	-	Version of the item.
commentUuid	-	UUID of the comment to delete.

itemExists

public abstract boolean itemExists(

java.lang.String itemUuid,
int itemVersion)

Determines if there is an existing item with the supplied itemUuid and itemVersion

Parameters:
itemUuid	-	UUID of the item to look for
itemVersion	-	The version of the item to look for

Returns:
true if the item can be found (by the current user)

getItemFilenames

public abstract java.lang.String[] getItemFilenames(

java.lang.String itemUuid,
int itemVersion,
java.lang.String path,
boolean system)

A list of all the files stored with an item. Some, or all, of these files may be attachments on the item.

Parameters:
itemUuid	-	The uuid of the item to list the files of
itemVersion	-	The version of the item to list the files of
path	-	The folder to search through. This would be null or "" for the top level.

Returns:
A list of filenames, relative to the item's URL

getTaskFilterCounts

public abstract java.lang.String getTaskFilterCounts(

boolean ignoreZero)

getTaskFilterNames

public abstract java.lang.String[] getTaskFilterNames(

)

getTaskList

public abstract java.lang.String getTaskList(	java.lang.String filterName, int start, int numResults)
throws	java.lang.Exception

getUser

public abstract java.lang.String getUser(	java.lang.String userId)
throws	java.lang.Exception

Retrieves an internal EQUELLA user with the id of userId.

Parameters:
userId	-	The unique ID of the user to retrieve.

Returns:
An XML user object representing the user's details. See the section on XML Formats in `SOAP Services` for the format of the User XML

Throws:
java.lang.Exception - Will throw a NotFoundException if the user cannot be found.

addUser

public abstract java.lang.String addUser(

java.lang.String userId,
java.lang.String username,
java.lang.String password,
java.lang.String firstName,
java.lang.String lastName,
java.lang.String email)

Creates an internal EQUELLA user on the server. This does not assign the user to any groups, roles or permissions.

Parameters:
userId	-	The unique ID of the new user.
username	-	The new user's username.
password	-	The new user's password.
firstName	-	The user's first name.
lastName	-	The user's last name.
email	-	The user's email address.

Returns:
The unique ID of the new user.

editUser

public abstract java.lang.String editUser(

java.lang.String userId,
java.lang.String username,
java.lang.String password,
java.lang.String firstName,
java.lang.String lastName,
java.lang.String email)

Update the user on the server with the modifications made to the user. You may optionally specifiy a new password for the user.

Parameters:
userId	-	The unique ID of the user to edit.
username	-	The user's new username.
password	-	The user's new password in plain text. May be null, in which case the password is not changed.
firstName	-	The user's new first name.
lastName	-	The user's new last name.
email	-	The user's new email address.

Returns:
The unique ID of the user.

deleteUser

public abstract void deleteUser(

java.lang.String userId)

Deletes the user from the EQUELLA server. Use with caution.

Parameters:
userId	-	The unique ID of the user to delete.

addUserToGroup

public abstract void addUserToGroup(

java.lang.String userId,
java.lang.String groupId)

Adds the user (external or internal) with the id of userId to the internal EQUELLA group with the id of groupId.

Parameters:
userId	-	The unique ID of user to add.
groupId	-	The unique ID of the group to add to.

removeUserFromGroup

public abstract void removeUserFromGroup(

java.lang.String userId,
java.lang.String groupId)

Remove the user (external or internal) with the id of userId from the internal EQUELLA group with the id of groupId.

Parameters:
userId	-	The unique ID of user to remove
groupId	-	The unique ID of the group to remove from.

removeUserFromAllGroups

public abstract void removeUserFromAllGroups(

java.lang.String userId)

Remove the user (external or internal) with the id of userId from all internal EQUELLA groups. Use with caution.

Parameters:
userId	-	The unqiue ID of the user to remove from all groups.

isUserInGroup

public abstract boolean isUserInGroup(

java.lang.String userId,
java.lang.String groupId)

Is the user (external or internal) with id of userId directly in (that is, not in a subgroup of) the internal EQUELLA group with the id of groupId.

Parameters:
userId	-	The unique ID of the user to check for.
groupId	-	The unique ID of the group to look in.

Returns:
true if user is in group.

userExists

public abstract boolean userExists(

java.lang.String userId)

Determine if the internal EQUELLA user with the id of userId exists.

Parameters:
userId	-	The unique ID of the user to find.

userNameExists

public abstract boolean userNameExists(

java.lang.String username)

Determine if the internal EQUELLA user with the login name of username exists.

Parameters:
username	-	The login name of the user to find.

groupExists

public abstract boolean groupExists(

java.lang.String groupId)

Determine if the internal EQUELLA group with the id of groupId exists.

Parameters:
groupId	-	The unique ID of the group to find.

getGroupUuidForName

public abstract java.lang.String getGroupUuidForName(

java.lang.String groupName)

Find the id of the internal EQUELLA group with the name of groupName.

Parameters:
groupName	-	The name of the group to find.

addGroup

public abstract void addGroup(

java.lang.String groupId,
java.lang.String groupName)

Adds an internal EQUELLA group with the given groupId and groupName to the server.

Parameters:
groupId	-	The unique ID of the new group.
groupName	-	The name of the new group.

deleteGroup

public abstract void deleteGroup(

java.lang.String groupId)

Deletes an internal EQUELLA group with the given groupId. Use with caution.

Parameters:
groupId	-	The unique ID of the group to delete.

removeAllUsersFromGroup

public abstract void removeAllUsersFromGroup(

java.lang.String groupId)

Removes all the users (internal and external) from the internal EQUELLA group with id of groupId. Use with caution.

Parameters:
groupId	-	The unique ID of the group to remove all users from.