From ab6bde17deffe3c79bc93cf86e6eb5dc3fc16432 Mon Sep 17 00:00:00 2001
From: brinn <brinn>
Date: Wed, 18 Jul 2012 09:02:01 +0000
Subject: [PATCH] Improve javadoc.
SVN: 26143
---
.../dss/etl/dto/api/v1/BasicDataSetInformation.java | 9 ++++++++-
1 file changed, 8 insertions(+), 1 deletion(-)
diff --git a/screening/source/java/ch/systemsx/cisd/openbis/dss/etl/dto/api/v1/BasicDataSetInformation.java b/screening/source/java/ch/systemsx/cisd/openbis/dss/etl/dto/api/v1/BasicDataSetInformation.java
index 84e47523830..99bcf07c630 100644
--- a/screening/source/java/ch/systemsx/cisd/openbis/dss/etl/dto/api/v1/BasicDataSetInformation.java
+++ b/screening/source/java/ch/systemsx/cisd/openbis/dss/etl/dto/api/v1/BasicDataSetInformation.java
@@ -50,7 +50,14 @@ public class BasicDataSetInformation extends DataSetInformation
this.fileFormatTypeCode = fileFormatCode;
}
- /** Mandatory: sets attributes of the connected sample */
+ /**
+ * Sets attributes of the connected sample - optional.
+ * <p>
+ * Alternatively, call
+ * {@link ch.systemsx.cisd.etlserver.registrator.api.v1.IDataSetUpdatable#setSample(ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v1.ISampleImmutable)}
+ * on the object returned by
+ * {@link ch.systemsx.cisd.etlserver.registrator.api.v1.IDataSetRegistrationTransaction#createNewDataSet()}.
+ */
public void setSample(String sampleSpaceCode, String sampleCode)
{
super.setSpaceCode(sampleSpaceCode);
--
GitLab