Package ch.systemsx.cisd.etlserver.registrator.api.v2

Interface ISample

  • All Superinterfaces:
    ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IMetaprojectContent, ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable
    All Known Implementing Classes:
    Sample
    public interface ISample
extends ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addAttachment​(java.lang.String filePath, java.lang.String title, java.lang.String description, byte[] content)
      Add a new attachment to this sample.
      void setContainer​(ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable container)
      Set the container for this sample.
      void setExperiment​(ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IExperimentImmutable experiment)
      Set the experiment for this sample.
      void setParentSampleIdentifiers​(java.util.List<java.lang.String> parentSampleIdentifiers)
      Set the parent samples of this sample.
      void setProject​(ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IProjectImmutable project)
      Set the project for this sample.
      void setPropertyValue​(java.lang.String propertyCode, java.lang.String propertyValue)
      Set the value for a property.
      void setSampleType​(java.lang.String type)
      Set the type for this sample.

      • Methods inherited from interface ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IMetaprojectContent

        getEntityId

      • Methods inherited from interface ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable

        canGetContainedSamples, getCode, getContainedSamples, getExperiment, getParentSampleIdentifiers, getPermId, getProject, getPropertyValue, getSampleIdentifier, getSampleType, getSpace, isExistingSample

    • Method Detail

      • setExperiment

        void setExperiment​(ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IExperimentImmutable experiment)
        Set the experiment for this sample. The experiment need not be immutable, but the immutable one is the superclass.

      • setProject

        void setProject​(ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.IProjectImmutable project)
        Set the project for this sample. The project need not be immutable, but the immutable one is the superclass.

      • setSampleType

        void setSampleType​(java.lang.String type)
        Set the type for this sample.

      • setContainer

        void setContainer​(ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2.ISampleImmutable container)
        Set the container for this sample.

      • setPropertyValue

        void setPropertyValue​(java.lang.String propertyCode,
                      java.lang.String propertyValue)
        Set the value for a property.

      • setParentSampleIdentifiers

        void setParentSampleIdentifiers​(java.util.List<java.lang.String> parentSampleIdentifiers)
        Set the parent samples of this sample.

      • addAttachment

        void addAttachment​(java.lang.String filePath,
                   java.lang.String title,
                   java.lang.String description,
                   byte[] content)
        Add a new attachment to this sample.
        Parameters:
        filePath - The path of the attachment as reported to the database.
        title - The title of the attachment.
        description - A description of the attachment.
        content - The actual content of the attachment.