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

Interface IGeneralInformationChangingService

All Superinterfaces:
IRpcService
public interface IGeneralInformationChangingService extends IRpcService
Service for changing general informations.

  • Field Details

    • SERVICE_NAME

      static final String SERVICE_NAME
      Name of this service for which it is registered at the RPC name server.
      See Also:

    • SERVICE_URL

      static final String SERVICE_URL
      Application part of the URL to access this service remotely.
      See Also:

    • JSON_SERVICE_URL

      static final String JSON_SERVICE_URL
      URL where the service is exposed via JSON interface.
      See Also:

  • Method Details

    • updateSampleProperties

      void updateSampleProperties(String sessionToken, long sampleID, Map<String,String> properties)

    • addUnofficialVocabularyTerm

      @Deprecated void addUnofficialVocabularyTerm(String sessionToken, TechId vocabularyId, String code, String label, String description, Long previousTermOrdinal, boolean managedInternally)
      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(String sessionToken, Long vocabularyId, NewVocabularyTerm term, boolean managedInternally)
      Adds new unofficial terms to a vocabulary starting from specified ordinal + 1.

    • getWebAppSettings

      WebAppSettings getWebAppSettings(String sessionToken, 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(String sessionToken, WebAppSettings webAppSettings)
      Sets the persistent settings for a given custom web app.
      Parameters:
      webAppSettings - The new display settings
      Since:
      1.2

    • createMetaproject

      Metaproject createMetaproject(String sessionToken, String name, 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

      Metaproject updateMetaproject(String sessionToken, IMetaprojectId metaprojectId, String name, 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(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(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(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

    • registerSamplesWithSilentOverrides

      String registerSamplesWithSilentOverrides(String sessionToken, String sampleTypeCode, String spaceIdentifierSilentOverrideOrNull, String experimentIdentifierSilentOverrideOrNull, String sessionKey, String defaultGroupIdentifier)
      Registers samples parsing a file stored on the HTTP Session.
      Parameters:
      sampleTypeCode - Sample type to parse
      spaceIdentifierSilentOverrideOrNull - Silently overrides Space identifier if given
      experimentIdentifierSilentOverrideOrNull - Silently overrides Experiment identifier if given
      sessionKey - key of the file stored on the HTTP Session
      defaultGroupIdentifier -
      Since:
      1.5

    • registerSamples

      String registerSamples(String sessionToken, String sampleTypeCode, String sessionKey, 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 -
      Since:
      1.5

    • updateSamplesWithSilentOverrides

      String updateSamplesWithSilentOverrides(String sessionToken, String sampleTypeCode, String spaceIdentifierSilentOverrideOrNull, String experimentIdentifierSilentOverrideOrNull, String sessionKey, 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 -
      Since:
      1.5

    • updateSamples

      String updateSamples(String sessionToken, String sampleTypeCode, String sessionKey, 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 -
      Since:
      1.5

    • uploadedSamplesInfo

      Map<String,Object> uploadedSamplesInfo(String sessionToken, String sampleTypeCode, 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(String sessionToken, List<Long> projectIds, String reason)
      Deletes the specified projects.
      Parameters:
      projectIds - Ids of projects to delete
      reason - Reason of the deletion
      Since:
      1.6

    • deleteExperiments

      void deleteExperiments(String sessionToken, List<Long> experimentIds, 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(String sessionToken, List<Long> sampleIds, 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(String sessionToken, List<String> dataSetCodes, 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(String sessionToken, List<String> dataSetCodes, 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(String sessionToken, List<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(String sessionToken, List<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(String sessionToken, List<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

    • registerPerson

      void registerPerson(String sessionToken, String userID)
      Registers Person, this person should be available in one of the configured login systems to be usable.
      Parameters:
      userID - user to be added to the system
      Since:
      1.7

    • registerSpace

      void registerSpace(String sessionToken, String spaceCode, String spaceDescription)
      Registers a space.
      Parameters:
      spaceCode - space code
      spaceDescription - space description
      Since:
      1.7

    • registerPersonSpaceRole

      void registerPersonSpaceRole(String sessionToken, String spaceCode, String userID, String roleCode)
      Registers a space role for a given person.
      Parameters:
      spaceCode - space code
      userID - user id
      roleCode - openBIS role
      Since:
      1.7