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
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
 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 deleteMetaproject(java.lang.String sessionToken, IMetaprojectId metaprojectId)
          Deletes an existing metaproject.
 WebAppSettings getWebAppSettings(java.lang.String sessionToken, java.lang.String webAppId)
          Returns the persistent settings for a given custom web app.
 void removeFromMetaproject(java.lang.String sessionToken, IMetaprojectId metaprojectId, MetaprojectAssignmentsIds assignmentsToRemove)
          Removes given entities from an existing metaproject.
 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)
           
 
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