uk.ac.sheffield.vtts.client.ws

Interface DocumentStoreInterface

public interface DocumentStoreInterface

DocumentStoreInterface is a skeleton of the JAX-WS client interface for the JAX-WS implementation of the DocumentStore.xml example. This is a placeholder until you develop your own interface using JAX-WS tools.

Version:

1.0

Author:

Anthony J H Simons

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Integer	deleteVersion(java.lang.Integer docid, java.lang.Integer version) Attempts to delete a given version of a document with the given docid.
Document	getDocument(java.lang.Integer docid) Attempts to retrieve a document under the docid.
java.lang.Integer	getEncryption() Returns the encryption standard for the customer.
java.lang.String	getScenario() Returns the last scenario that was enacted.
java.lang.String	getState() Returns the last state that was entered.
java.lang.Integer	getStorageLimit() Returns the storage allocation limit for the customer.
java.lang.Integer	getStorageUsed() Returns the storage used by the customer.
Document	getVersion(java.lang.Integer docid, java.lang.Integer version) Attempts to retrieve a given version of a document with the given docid.
java.util.List<java.lang.Object>	login(java.lang.String username, java.lang.String password) Attempts to login with the given credentials.
void	logout() Logs out of the service, if logged in.
java.util.List<java.lang.Object>	putDocument(java.lang.Integer docid, Document document) Attempts to store a document under the docid.
void	reset() Resets the service to its clean initial state.

Method Detail

reset

void reset()

Resets the service to its clean initial state.

getScenario

java.lang.String getScenario()

Returns the last scenario that was enacted.

Returns:

the last scenario that was enacted.

getState

java.lang.String getState()

Returns the last state that was entered.

Returns:

the last state that was entered.

login

java.util.List<java.lang.Object> login(java.lang.String username,
                                     java.lang.String password)

Attempts to login with the given credentials.

Parameters:

username - the customer's name.

password - the customer's password.

Returns:

a list of the storage allocation and encryption standard.

logout

void logout()

Logs out of the service, if logged in.

getEncryption

java.lang.Integer getEncryption()

Returns the encryption standard for the customer.

Returns:

the encryption standard, or null if ignored.

getStorageLimit

java.lang.Integer getStorageLimit()

Returns the storage allocation limit for the customer.

Returns:

the storage limit, or null if ignored.

getStorageUsed

java.lang.Integer getStorageUsed()

Returns the storage used by the customer.

Returns:

the storage used, or null if ignored.

putDocument

java.util.List<java.lang.Object> putDocument(java.lang.Integer docid,
                                           Document document)

Attempts to store a document under the docid. Fails if the docid is out of range, or the document is too large. If the docid is already known, adds the document as the latest version. Otherwise starts a new document history with the document as the first version.

Parameters:

docid - the document index.

document - the Document.

Returns:

a list of the remaining storage; and the latest version or null, if not stored.

getDocument

Document getDocument(java.lang.Integer docid)

Attempts to retrieve a document under the docid. Fails if the docid is out of range, or no versions exist. Otherwise returns the latest version of that document.

Parameters:

docid - the document index.

Returns:

the latest version of the Document.

getVersion

Document getVersion(java.lang.Integer docid,
                  java.lang.Integer version)

Attempts to retrieve a given version of a document with the given docid. Fails if the docid is out of range, or the version is out of range. Otherwise returns that version of the document.

Parameters:

docid - the document index.

version - the version index.

Returns:

the document, or null if ignored.

deleteVersion

java.lang.Integer deleteVersion(java.lang.Integer docid,
                              java.lang.Integer version)

Attempts to delete a given version of a document with the given docid. Fails if the docid is out of range or the version is out of range. Otherwise, deletes the version of the document and returns the new amount of remaining storage.

Parameters:

docid - the document index.

version - the version index.

Returns:

the remaining storage.