public abstract class PartiallyWritableDatabaseService extends DatabaseService
DocumentField.NAME_FIELD using
editDocumentField(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument, com.biomatters.geneious.publicapi.documents.DocumentFieldAndValue)DatabaseService.SequenceSearchQueryTypeGeneiousService.ServiceStatus| Constructor and Description |
|---|
PartiallyWritableDatabaseService() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
canDeleteDocuments(List<AnnotatedPluginDocument> documents)
Return true if it is possible to delete all the documents in the list.
|
boolean |
canEditDocumentField(AnnotatedPluginDocument document,
DocumentField field)
Returns true if it is possible to edit the given document field for the given document.
|
void |
deleteDocuments(List<AnnotatedPluginDocument> documents)
Deletes documents in this database.
|
void |
editDocumentField(AnnotatedPluginDocument document,
DocumentFieldAndValue newValue)
Edits a field value on a document.
|
addDatabaseServiceListener, addWeakDatabaseServiceListener, batchSequenceSearch, getDatabaseServiceListeners, getDocumentTypesForSequenceSearch, getExtendedSearchOptions, getSearchFields, getSequenceSearchOptions, getSequenceSearchPrograms, isBrowsable, locateSummaryDocument, removeDatabaseServiceListener, resumeSearch, retrieve, retrieve, retrieve, retrieve, retrieve, retrieve, sequenceSearch_shutdown, addGeneiousServiceListener, addWeakGeneiousServiceListener, canShutdown, getActionsAlwaysEnabled, getActionsEnabledWhenServiceSelected, getChildServices, getDescription, getFullPath, getGeneiousServiceListener, getHelp, getIcons, getName, getParentService, getPreferences, getServiceTreeLabel, getStatus, getUniqueID, hasShutdownOrStartedShuttingDown, initialize, initializeService, isProOnly, removeGeneiousServiceListener, showInServiceTree, shutdown, toStringpublic boolean canDeleteDocuments(List<AnnotatedPluginDocument> documents)
DatabaseService.retrieve(Query, jebl.util.ProgressListener) methods.documents - a list of documents which are guaranteed to have come from one of the
DatabaseService DatabaseService.retrieve(Query, jebl.util.ProgressListener) methods.public void deleteDocuments(List<AnnotatedPluginDocument> documents) throws DatabaseServiceException
DatabaseService.retrieve(Query, jebl.util.ProgressListener) methods. canDeleteDocuments(java.util.List)
will be called before the list is passed to this method.documents - a list of documents which are guaranteed to have come from one of the
DatabaseService DatabaseService.retrieve(Query, jebl.util.ProgressListener) methods.DatabaseServiceException - if the documents cannot be deleted for some reason.public boolean canEditDocumentField(AnnotatedPluginDocument document, DocumentField field)
DatabaseService.retrieve(Query, jebl.util.ProgressListener) methods.document - a document which is guaranteed to have come from one of the
DatabaseService DatabaseService.retrieve(Query, jebl.util.ProgressListener) methods.field - The Document field to checkpublic void editDocumentField(AnnotatedPluginDocument document, DocumentFieldAndValue newValue) throws DatabaseServiceException
DatabaseService.retrieve(Query, jebl.util.ProgressListener) methods. canEditDocumentField(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument, com.biomatters.geneious.publicapi.documents.DocumentField)
will be called before the documents are passed to this method.document - a document to edit which is guaranteed to have come from one of the
DatabaseService DatabaseService.retrieve(Query, jebl.util.ProgressListener) methods.newValue - The new value to apply to the documentDatabaseServiceException - if it is not possible to edit the document for some reason