|
| |
|
| java.lang.Object
 org.purl.sword.base.ServiceDocument
| ServiceDocument | | public class ServiceDocument (Code) | | A representation of a SWORD Service Document.
http://www.ukoln.ac.uk/repositories/digirep/index/SWORD_APP_Profile_0.5
author:
Stuart Lewis
author:
Neil Taylor |
| ServiceDocument | | public ServiceDocument()(Code) | | Create a new instance and set the initial service level to Zero.
|
| ServiceDocument | | public ServiceDocument(ServiceLevel complianceLevel)(Code) | | Create a new instance and set the specified service level.
Parameters:
complianceLevel - The service compliance level. |
| ServiceDocument | | public ServiceDocument(Service service)(Code) | | Create a new instance and store the specified Service document.
Parameters:
service - The Service object. |
| ServiceDocument | | public ServiceDocument(ServiceLevel complianceLevel, boolean noOp, boolean verbose, String workspaceTitle, Collection workspaceCollections)(Code) | | Instantiate a ServiceDocument
Parameters:
complianceLevel - The compliance level of this implementation
Parameters:
noOp - Whether or not the NOOP option is available
Parameters:
verbose - Whether or not the verbose option is available
Parameters:
workspaceTitle - The name of the workspace title
Parameters:
workspaceCollections - A Collection of workspaces |
| addWorkspace | | public void addWorkspace(Workspace workspace)(Code) | |
Parameters:
workspace - |
| getComplianceLevel | | public ServiceLevel getComplianceLevel()(Code) | | Get the compliance level from this Service Document
The compliance level |
| getService | | public Service getService()(Code) | | Retrieve the Service object associated with this document.
The Service object. |
| getWorkspaceCollections | | public Iterator<Collection> getWorkspaceCollections()(Code) | | Returns the Collectinos in the workspace described by the Service Document
The workspaces |
| marshall | | public String marshall()(Code) | | Marshall the data in the Service element and generate a String representation.
The returned string is UTF-8 format.
A string of XML, or null if there was an errormarshalling the data. |
| setNoOp | | public void setNoOp(boolean noOp)(Code) | |
Parameters:
noOp - |
| setService | | public void setService(Service service)(Code) | | Set the service object associated with this document.
Parameters:
service - The new Service object. |
| setVerbose | | public void setVerbose(boolean verbose)(Code) | |
Parameters:
verbose - |
| supportsNoOp | | public boolean supportsNoOp()(Code) | | Returns a boolean depending on whether or not the Service Document
says the server supports the NOOP option
The NOOP option status |
| supportsVerbose | | public boolean supportsVerbose()(Code) | | Returns a boolean depending on whether or not the Service Document
says the server supports the verbose option
The verbose option status |
| toString | | public String toString()(Code) | | Return the Service Document in it's XML form.
The ServiceDocument |
| unmarshall | | public void unmarshall(String xml) throws UnmarshallException(Code) | | Convert the specified XML string into a set of objects
used within the service. A new Service object will be
created and stored. This will dispose of any previous
Service object associated with this object.
Parameters:
xml - The XML string.
throws:
UnmarshallException - If there was a problem unmarshalling the data. This might be as a result of an error in parsing the XML string, extracting information. |
|
|
|