ch.systemsx.cisd.openbis.generic.shared.api.v1

Interface IGeneralInformationChangingService

All Superinterfaces:

IRpcService

public interface IGeneralInformationChangingService
extends IRpcService

Service for changing general informations.

Field Summary

Fields

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.

Method Summary

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.

Methods inherited from interface ch.systemsx.cisd.common.api.IRpcService

getMajorVersion, getMinorVersion

Field Detail

SERVICE_NAME

static final java.lang.String SERVICE_NAME

Name of this service for which it is registered at the RPC name server.

See Also:

Constant Field Values

SERVICE_URL

static final java.lang.String SERVICE_URL

Application part of the URL to access this service remotely.

See Also:

Constant Field Values

JSON_SERVICE_URL

static final java.lang.String JSON_SERVICE_URL

URL where the service is exposed via JSON interface.

See Also:

Constant Field Values

Method Detail

updateSampleProperties

void updateSampleProperties(java.lang.String sessionToken,
                            long sampleID,
                            java.util.Map<java.lang.String,java.lang.String> properties)

addUnofficialVocabularyTerm

@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)

Deprecated. Because the parameters refer to an internal openBIS class (TechID).

Adds new unofficial terms to a vocabulary starting from specified ordinal + 1.

addUnofficialVocabularyTerm

void addUnofficialVocabularyTerm(java.lang.String sessionToken,
                                 java.lang.Long vocabularyId,
                                 NewVocabularyTerm term)

Adds new unofficial terms to a vocabulary starting from specified ordinal + 1.

getWebAppSettings

WebAppSettings getWebAppSettings(java.lang.String sessionToken,
                                 java.lang.String webAppId)

Returns the persistent settings for a given custom web app.

Parameters:

webAppId - The id of the custom web app to get the display settings for.

Since:

1.2

setWebAppSettings

void setWebAppSettings(java.lang.String sessionToken,
                       WebAppSettings webAppSettings)

Sets the persistent settings for a given custom web app.

Parameters:

webAppSettings - The new display settings

Since:

1.2

createMetaproject

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.

Parameters:

name - Name of the metaproject

descriptionOrNull - Description of the metaproject

Returns:

Newly created metaproject

Since:

1.3

updateMetaproject

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.

Parameters:

metaprojectId - Id of the metaproject to update

name - New name of the metaproject

descriptionOrNull - New description of the metaproject

Returns:

Updated metaproject

Throws:

UserFailureException - when a metaproject with the specified id doesn't exist.

Since:

1.3

deleteMetaproject

void deleteMetaproject(java.lang.String sessionToken,
                       IMetaprojectId metaprojectId)

Deletes an existing metaproject.

Parameters:

metaprojectId - Id of the metaproject to delete

Throws:

UserFailureException - when a metaproject with the specified id doesn't exist.

Since:

1.3

addToMetaproject

void addToMetaproject(java.lang.String sessionToken,
                      IMetaprojectId metaprojectId,
                      MetaprojectAssignmentsIds assignmentsToAdd)

Adds given entities to an existing metaproject.

Parameters:

metaprojectId - Id of the metaproject

assignmentsToAdd - Assignments that should be added to the metaproject

Throws:

UserFailureException - when a metaproject with the specified id doesn't exist.

Since:

1.3

removeFromMetaproject

void removeFromMetaproject(java.lang.String sessionToken,
                           IMetaprojectId metaprojectId,
                           MetaprojectAssignmentsIds assignmentsToRemove)

Removes given entities from an existing metaproject.

Parameters:

metaprojectId - Id of the metaproject

assignmentsToRemove - Assignments that should be removed from the metaproject

Throws:

UserFailureException - when a metaproject with the specified id doesn't exist.

Since:

1.3

registerSamples

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.

Parameters:

sampleTypeCode - Sample type to parse

sessionKey - key of the file stored on the HTTP Session

defaultGroupIdentifier - key of the file stored on the HTTP Session

Since:

1.5

updateSamples

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.

Parameters:

sampleTypeCode - Sample type to parse

sessionKey - key of the file stored on the HTTP Session

defaultGroupIdentifier - key of the file stored on the HTTP Session

Since:

1.5

uploadedSamplesInfo

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.

Parameters:

sampleTypeCode - Sample type to parse

sessionKey - key of the file stored on the HTTP Session

Since:

1.5

deleteProjects

void deleteProjects(java.lang.String sessionToken,
                    java.util.List<java.lang.Long> projectIds,
                    java.lang.String reason)

Deletes the specified projects.

Parameters:

projectIds - Ids of projects to delete

reason - Reason of the deletion

Since:

1.6

deleteExperiments

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.

Parameters:

experimentIds - Ids of experiments to delete

reason - Reason of the deletion

deletionType - Type of the deletion

Since:

1.6

deleteSamples

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.

Parameters:

sampleIds - Ids of samples to delete

reason - Reason of the deletion

deletionType - Type of the deletion

Since:

1.6

deleteDataSets

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. This method CANNOT delete data sets with deletion_disallow flag set to true in their type (compare with deleteDataSetsForced(String, List, String, DeletionType).

Parameters:

dataSetCodes - Codes of data sets to delete

reason - Reason of the deletion

deletionType - Type of the deletion

Since:

1.6

deleteDataSetsForced

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. This method CAN delete data sets with deletion_disallow flag set to true in their type but requires special user privileges (compare with deleteDataSets(String, List, String, DeletionType).

Parameters:

dataSetCodes - Codes of data sets to delete

reason - Reason of the deletion

deletionType - Type of the deletion

Since:

1.6

revertDeletions

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).

Parameters:

deletionIds - Ids of deletions to be reverted

Since:

1.6

deletePermanently

void deletePermanently(java.lang.String sessionToken,
                       java.util.List<java.lang.Long> deletionIds)

Permanently deletes entities moved to trash in specified deletions. This method CANNOT delete data sets with deletion_disallow flag set to true in their type (compare with deletePermanentlyForced(String, List))

Parameters:

deletionIds - Ids of deletions to be deleted permanently

Since:

1.6

deletePermanentlyForced

void deletePermanentlyForced(java.lang.String sessionToken,
                             java.util.List<java.lang.Long> deletionIds)

Permanently deletes entities moved to trash in specified deletions. It CAN delete data sets with deletion_disallow flag set to true in their type (compare with deletePermanently(String, List)).

Parameters:

deletionIds - Ids of deletions to be deleted permanently

Since:

1.6