public interface IGeneralInformationChangingService extends IRpcService
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
JSON_SERVICE_URL
URL where the service is exposed via JSON interface.
|
static java.lang.String |
SERVICE_NAME
Name of this service for which it is registered at the RPC name server.
|
static java.lang.String |
SERVICE_URL
Application part of the URL to access this service remotely.
|
Modifier and Type | Method and Description |
---|---|
void |
addToMetaproject(java.lang.String sessionToken,
IMetaprojectId metaprojectId,
MetaprojectAssignmentsIds assignmentsToAdd)
Adds given entities to an existing metaproject.
|
void |
addUnofficialVocabularyTerm(java.lang.String sessionToken,
java.lang.Long vocabularyId,
NewVocabularyTerm term)
Adds new unofficial terms to a vocabulary starting from specified ordinal + 1.
|
void |
addUnofficialVocabularyTerm(java.lang.String sessionToken,
ch.systemsx.cisd.openbis.generic.shared.basic.TechId vocabularyId,
java.lang.String code,
java.lang.String label,
java.lang.String description,
java.lang.Long previousTermOrdinal)
Deprecated.
Because the parameters refer to an internal openBIS class (TechID).
|
ch.systemsx.cisd.openbis.generic.shared.basic.dto.Metaproject |
createMetaproject(java.lang.String sessionToken,
java.lang.String name,
java.lang.String descriptionOrNull)
Creates a new metaproject.
|
void |
deleteDataSets(java.lang.String sessionToken,
java.util.List<java.lang.String> dataSetCodes,
java.lang.String reason,
DeletionType deletionType)
Deletes or trashes the specified data sets depending on the chosen deletion type.
|
void |
deleteDataSetsForced(java.lang.String sessionToken,
java.util.List<java.lang.String> dataSetCodes,
java.lang.String reason,
DeletionType deletionType)
Deletes or trashes the specified data sets depending on the chosen deletion type.
|
void |
deleteExperiments(java.lang.String sessionToken,
java.util.List<java.lang.Long> experimentIds,
java.lang.String reason,
DeletionType deletionType)
Deletes or trashes the specified experiments depending on the chosen deletion type.
|
void |
deleteMetaproject(java.lang.String sessionToken,
IMetaprojectId metaprojectId)
Deletes an existing metaproject.
|
void |
deletePermanently(java.lang.String sessionToken,
java.util.List<java.lang.Long> deletionIds)
Permanently deletes entities moved to trash in specified deletions.
|
void |
deletePermanentlyForced(java.lang.String sessionToken,
java.util.List<java.lang.Long> deletionIds)
Permanently deletes entities moved to trash in specified deletions.
|
void |
deleteProjects(java.lang.String sessionToken,
java.util.List<java.lang.Long> projectIds,
java.lang.String reason)
Deletes the specified projects.
|
void |
deleteSamples(java.lang.String sessionToken,
java.util.List<java.lang.Long> sampleIds,
java.lang.String reason,
DeletionType deletionType)
Deletes or trashes the specified samples depending on the chosen deletion type.
|
WebAppSettings |
getWebAppSettings(java.lang.String sessionToken,
java.lang.String webAppId)
Returns the persistent settings for a given custom web app.
|
java.lang.String |
registerSamples(java.lang.String sessionToken,
java.lang.String sampleTypeCode,
java.lang.String sessionKey,
java.lang.String defaultGroupIdentifier)
Registers samples parsing a file stored on the HTTP Session.
|
void |
removeFromMetaproject(java.lang.String sessionToken,
IMetaprojectId metaprojectId,
MetaprojectAssignmentsIds assignmentsToRemove)
Removes given entities from an existing metaproject.
|
void |
revertDeletions(java.lang.String sessionToken,
java.util.List<java.lang.Long> deletionIds)
Reverts specified deletions (puts back all entities moved to trash in the deletions).
|
void |
setWebAppSettings(java.lang.String sessionToken,
WebAppSettings webAppSettings)
Sets the persistent settings for a given custom web app.
|
ch.systemsx.cisd.openbis.generic.shared.basic.dto.Metaproject |
updateMetaproject(java.lang.String sessionToken,
IMetaprojectId metaprojectId,
java.lang.String name,
java.lang.String descriptionOrNull)
Updates an existing metaproject.
|
void |
updateSampleProperties(java.lang.String sessionToken,
long sampleID,
java.util.Map<java.lang.String,java.lang.String> properties) |
java.lang.String |
updateSamples(java.lang.String sessionToken,
java.lang.String sampleTypeCode,
java.lang.String sessionKey,
java.lang.String defaultGroupIdentifier)
Updates samples parsing a file stored on the HTTP Session.
|
java.util.Map<java.lang.String,java.lang.Object> |
uploadedSamplesInfo(java.lang.String sessionToken,
java.lang.String sampleTypeCode,
java.lang.String sessionKey)
Returns information regarding the uploaded file without discarding it.
|
getMajorVersion, getMinorVersion
static final java.lang.String SERVICE_NAME
static final java.lang.String SERVICE_URL
static final java.lang.String JSON_SERVICE_URL
void updateSampleProperties(java.lang.String sessionToken, long sampleID, java.util.Map<java.lang.String,java.lang.String> properties)
@Deprecated void addUnofficialVocabularyTerm(java.lang.String sessionToken, ch.systemsx.cisd.openbis.generic.shared.basic.TechId vocabularyId, java.lang.String code, java.lang.String label, java.lang.String description, java.lang.Long previousTermOrdinal)
void addUnofficialVocabularyTerm(java.lang.String sessionToken, java.lang.Long vocabularyId, NewVocabularyTerm term)
WebAppSettings getWebAppSettings(java.lang.String sessionToken, java.lang.String webAppId)
webAppId
- The id of the custom web app to get the display settings for.void setWebAppSettings(java.lang.String sessionToken, WebAppSettings webAppSettings)
webAppSettings
- The new display settingsch.systemsx.cisd.openbis.generic.shared.basic.dto.Metaproject createMetaproject(java.lang.String sessionToken, java.lang.String name, java.lang.String descriptionOrNull)
name
- Name of the metaprojectdescriptionOrNull
- Description of the metaprojectch.systemsx.cisd.openbis.generic.shared.basic.dto.Metaproject updateMetaproject(java.lang.String sessionToken, IMetaprojectId metaprojectId, java.lang.String name, java.lang.String descriptionOrNull)
metaprojectId
- Id of the metaproject to updatename
- New name of the metaprojectdescriptionOrNull
- New description of the metaprojectUserFailureException
- when a metaproject with the specified id doesn't exist.void deleteMetaproject(java.lang.String sessionToken, IMetaprojectId metaprojectId)
metaprojectId
- Id of the metaproject to deleteUserFailureException
- when a metaproject with the specified id doesn't exist.void addToMetaproject(java.lang.String sessionToken, IMetaprojectId metaprojectId, MetaprojectAssignmentsIds assignmentsToAdd)
metaprojectId
- Id of the metaprojectassignmentsToAdd
- Assignments that should be added to the metaprojectUserFailureException
- when a metaproject with the specified id doesn't exist.void removeFromMetaproject(java.lang.String sessionToken, IMetaprojectId metaprojectId, MetaprojectAssignmentsIds assignmentsToRemove)
metaprojectId
- Id of the metaprojectassignmentsToRemove
- Assignments that should be removed from the metaprojectUserFailureException
- when a metaproject with the specified id doesn't exist.java.lang.String registerSamples(java.lang.String sessionToken, java.lang.String sampleTypeCode, java.lang.String sessionKey, java.lang.String defaultGroupIdentifier)
sampleTypeCode
- Sample type to parsesessionKey
- key of the file stored on the HTTP SessiondefaultGroupIdentifier
- key of the file stored on the HTTP Sessionjava.lang.String updateSamples(java.lang.String sessionToken, java.lang.String sampleTypeCode, java.lang.String sessionKey, java.lang.String defaultGroupIdentifier)
sampleTypeCode
- Sample type to parsesessionKey
- key of the file stored on the HTTP SessiondefaultGroupIdentifier
- key of the file stored on the HTTP Sessionjava.util.Map<java.lang.String,java.lang.Object> uploadedSamplesInfo(java.lang.String sessionToken, java.lang.String sampleTypeCode, java.lang.String sessionKey)
sampleTypeCode
- Sample type to parsesessionKey
- key of the file stored on the HTTP Sessionvoid deleteProjects(java.lang.String sessionToken, java.util.List<java.lang.Long> projectIds, java.lang.String reason)
projectIds
- Ids of projects to deletereason
- Reason of the deletionvoid deleteExperiments(java.lang.String sessionToken, java.util.List<java.lang.Long> experimentIds, java.lang.String reason, DeletionType deletionType)
experimentIds
- Ids of experiments to deletereason
- Reason of the deletiondeletionType
- Type of the deletionvoid deleteSamples(java.lang.String sessionToken, java.util.List<java.lang.Long> sampleIds, java.lang.String reason, DeletionType deletionType)
sampleIds
- Ids of samples to deletereason
- Reason of the deletiondeletionType
- Type of the deletionvoid deleteDataSets(java.lang.String sessionToken, java.util.List<java.lang.String> dataSetCodes, java.lang.String reason, DeletionType deletionType)
deleteDataSetsForced(String, List, String, DeletionType)
.dataSetCodes
- Codes of data sets to deletereason
- Reason of the deletiondeletionType
- Type of the deletionvoid deleteDataSetsForced(java.lang.String sessionToken, java.util.List<java.lang.String> dataSetCodes, java.lang.String reason, DeletionType deletionType)
deleteDataSets(String, List, String, DeletionType)
.dataSetCodes
- Codes of data sets to deletereason
- Reason of the deletiondeletionType
- Type of the deletionvoid revertDeletions(java.lang.String sessionToken, java.util.List<java.lang.Long> deletionIds)
deletionIds
- Ids of deletions to be revertedvoid deletePermanently(java.lang.String sessionToken, java.util.List<java.lang.Long> deletionIds)
deletePermanentlyForced(String, List)
)deletionIds
- Ids of deletions to be deleted permanentlyvoid deletePermanentlyForced(java.lang.String sessionToken, java.util.List<java.lang.Long> deletionIds)
deletePermanently(String, List)
).deletionIds
- Ids of deletions to be deleted permanently