public interface Repository
TaskFactory
Modifier and Type | Method and Description |
---|---|
java.lang.String |
createFolder(java.lang.String parentFolder,
java.lang.String newFolder)
Creates a new folder with the specified name.
|
java.net.URI |
createRetrieveURI(java.lang.String path,
java.lang.String version,
java.lang.String label)
A utility function to create a repository URI that is valid for retrieving an object from the
specified location.
|
java.net.URI |
createStoreURI(java.lang.String path,
java.lang.String label)
A utility function to create a repository URI that is valid for storing an object at the
specified location and with an optional label to be applied to the object when it is stored.
|
void |
deleteFolder(java.lang.String folder)
Deletes the specified folder and any content within it.
|
java.lang.Object |
getRepositoryHandle()
Returns the underlying repository handle.
|
void |
renameFolder(java.lang.String folder,
java.lang.String newName)
Renames the specified folder.
|
DocumentOutput |
retrieveDocument(java.lang.String path,
java.lang.String version,
java.lang.String label,
boolean autoManage)
Retrieves a document output from the specified path.
|
ModelOutput |
retrieveModel(java.lang.String path,
java.lang.String version,
java.lang.String label,
boolean autoManage)
Retrieves a model output from the specified path.
|
Processor |
retrieveProcessor(java.lang.String path,
java.lang.String version,
java.lang.String label,
ProcessorDiagram diagram)
Retrieves a node from the specified path and inserts it into the supplied diagram.
|
ProcessorStream |
retrieveStream(java.lang.String path,
java.lang.String version,
java.lang.String label,
boolean autoManage)
Retrieves a stream from the specified path.
|
java.lang.String |
storeDocument(DocumentOutput documentOutput,
java.lang.String path,
java.lang.String label)
Stores a document output to the specified location.
|
java.lang.String |
storeModel(ModelOutput modelOutput,
java.lang.String path,
java.lang.String label)
Stores a model output to the specified location.
|
java.lang.String |
storeProcessor(Processor node,
java.lang.String path,
java.lang.String label)
Stores a node to the specified location.
|
java.lang.String |
storeStream(ProcessorStream stream,
java.lang.String path,
java.lang.String label)
Stores a stream to the specified location.
|
ProcessorStream retrieveStream(java.lang.String path, java.lang.String version, java.lang.String label, boolean autoManage) throws java.net.URISyntaxException, SessionException
null
then the LATEST version is returned.
Code that needs to open streams privately without having them made visible to the
user should set the autoManage flag to false
.path
- the full path to the objectversion
- the version marker or null
label
- the label or null
autoManage
- whether the stream should be added to the stream managerjava.net.URISyntaxException
- if the method cannot construct a valid URISessionException
- if the stream cannot be retrieved for some reasonjava.lang.String storeStream(ProcessorStream stream, java.lang.String path, java.lang.String label) throws java.net.URISyntaxException, SessionException
stream
- the stream to be storedpath
- the pathlabel
- the label or null
java.net.URISyntaxException
- if the method cannot construct a valid URISessionException
- if the stream cannot be stored for some reasonProcessor retrieveProcessor(java.lang.String path, java.lang.String version, java.lang.String label, ProcessorDiagram diagram) throws java.net.URISyntaxException, SessionException
null
then the LATEST version is returned.path
- the full path to the objectversion
- the version marker or null
label
- the label or null
diagram
- the diagram that the node should be added tojava.net.URISyntaxException
- if the method cannot construct a valid URISessionException
- if the node cannot be retrieved for some reasonjava.lang.String storeProcessor(Processor node, java.lang.String path, java.lang.String label) throws java.net.URISyntaxException, SessionException
node
- the node to be storedpath
- the pathlabel
- the label or null
java.net.URISyntaxException
- if the method cannot construct a valid URISessionException
- if the node cannot be stored for some reasonModelOutput retrieveModel(java.lang.String path, java.lang.String version, java.lang.String label, boolean autoManage) throws java.net.URISyntaxException, SessionException
null
then the LATEST version is returned.
Code that needs to open models privately without having them made visible to the user
should set the autoManage flag to false
.path
- the full path to the objectversion
- the version marker or null
label
- the label or null
autoManage
- whether the model should be added to the model managerjava.net.URISyntaxException
- if the method cannot construct a valid URISessionException
- if the model output cannot be retrieved for some reasonjava.lang.String storeModel(ModelOutput modelOutput, java.lang.String path, java.lang.String label) throws java.net.URISyntaxException, SessionException
modelOutput
- the model output to be storedpath
- the pathlabel
- the label or null
java.net.URISyntaxException
- if the method cannot construct a valid URISessionException
- if the model output cannot be stored for some reasonDocumentOutput retrieveDocument(java.lang.String path, java.lang.String version, java.lang.String label, boolean autoManage) throws java.net.URISyntaxException, SessionException
null
then the LATEST version is returned.
Code that needs to open documents privately without having them made visible to the user
should set the autoManage flag to false
.path
- the full path to the objectversion
- the version marker or null
label
- the label or null
autoManage
- whether the document should be added to the output managerjava.net.URISyntaxException
- if the method cannot construct a valid URISessionException
- if the document output cannot be retrieved for some reasonjava.lang.String storeDocument(DocumentOutput documentOutput, java.lang.String path, java.lang.String label) throws java.net.URISyntaxException, SessionException
documentOutput
- the document output to be storedpath
- the pathlabel
- the label or null
java.net.URISyntaxException
- if the method cannot construct a valid URISessionException
- if the document output cannot be stored for some reasonjava.lang.String createFolder(java.lang.String parentFolder, java.lang.String newFolder) throws SessionException
parentFolder
- the path to the parent foldernewFolder
- the new folder nameSessionException
- if the folder cannot be createdvoid renameFolder(java.lang.String folder, java.lang.String newName) throws SessionException
folder
- the path of the folder to be renamednewName
- the new folder nameSessionException
- if the folder cannot be renamedvoid deleteFolder(java.lang.String folder) throws SessionException
folder
- the folder to be deletedSessionException
- if the folder cannot be deletedjava.lang.Object getRepositoryHandle()
com.spss.repository.client.application.jaxws.Repository
.java.net.URI createStoreURI(java.lang.String path, java.lang.String label) throws java.net.URISyntaxException
path
- the full path to the store locationlabel
- the label to be applied to the object or null
java.net.URISyntaxException
- if the method cannot construct a valid URIjava.net.URI createRetrieveURI(java.lang.String path, java.lang.String version, java.lang.String label) throws java.net.URISyntaxException
null
then the LATEST version will be returned.path
- the full path to the object to be retrievedversion
- the version marker or null
label
- the label or null
java.net.URISyntaxException
- if the method cannot construct a valid URICopyright © 2014 Integral Solutions Ltd. All Rights Reserved.