Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
O
openbis
Manage
Activity
Members
Labels
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
sispub
openbis
Commits
a58c1ae4
Commit
a58c1ae4
authored
12 years ago
by
brinn
Browse files
Options
Downloads
Patches
Plain Diff
Remove duplicate documentation of @since in javadoc text.
SVN: 26103
parent
7679e76c
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
openbis_api/source/java/ch/systemsx/cisd/openbis/generic/shared/api/v1/IGeneralInformationService.java
+15
-25
15 additions, 25 deletions
...bis/generic/shared/api/v1/IGeneralInformationService.java
with
15 additions
and
25 deletions
openbis_api/source/java/ch/systemsx/cisd/openbis/generic/shared/api/v1/IGeneralInformationService.java
+
15
−
25
View file @
a58c1ae4
...
@@ -71,8 +71,7 @@ public interface IGeneralInformationService extends IRpcService
...
@@ -71,8 +71,7 @@ public interface IGeneralInformationService extends IRpcService
public
void
logout
(
String
sessionToken
);
public
void
logout
(
String
sessionToken
);
/**
/**
* Returns true if session with the specified token is still active, false otherwise. Available
* Returns true if session with the specified token is still active, false otherwise.
* since minor version 4.
*
*
* @since 1.4
* @since 1.4
*/
*/
...
@@ -94,7 +93,7 @@ public interface IGeneralInformationService extends IRpcService
...
@@ -94,7 +93,7 @@ public interface IGeneralInformationService extends IRpcService
String
sessionToken
,
String
databaseInstanceCodeOrNull
);
String
sessionToken
,
String
databaseInstanceCodeOrNull
);
/**
/**
* Return all samples that match the search criteria.
Available since minor version 1.
* Return all samples that match the search criteria.
* This is a short cut for
* This is a short cut for
*
*
* <pre>
* <pre>
...
@@ -107,7 +106,7 @@ public interface IGeneralInformationService extends IRpcService
...
@@ -107,7 +106,7 @@ public interface IGeneralInformationService extends IRpcService
public
List
<
Sample
>
searchForSamples
(
String
sessionToken
,
SearchCriteria
searchCriteria
);
public
List
<
Sample
>
searchForSamples
(
String
sessionToken
,
SearchCriteria
searchCriteria
);
/**
/**
* Return all samples that match the search criteria.
Available since minor version 17.
* Return all samples that match the search criteria.
* <p>
* <p>
* The fetch options set is interpreted by the following rules.
* The fetch options set is interpreted by the following rules.
* <ul>
* <ul>
...
@@ -165,7 +164,7 @@ public interface IGeneralInformationService extends IRpcService
...
@@ -165,7 +164,7 @@ public interface IGeneralInformationService extends IRpcService
EnumSet
<
SampleFetchOption
>
fetchOptions
,
String
userId
);
EnumSet
<
SampleFetchOption
>
fetchOptions
,
String
userId
);
/**
/**
* Return all samples that belong to the supplied experiment.
Available since minor version 1.
* Return all samples that belong to the supplied experiment.
*
*
* @param experimentIdentifierString The identifier of the experiment samples will be listed
* @param experimentIdentifierString The identifier of the experiment samples will be listed
* for.
* for.
...
@@ -182,8 +181,7 @@ public interface IGeneralInformationService extends IRpcService
...
@@ -182,8 +181,7 @@ public interface IGeneralInformationService extends IRpcService
public
List
<
DataSet
>
listDataSets
(
String
sessionToken
,
List
<
Sample
>
samples
);
public
List
<
DataSet
>
listDataSets
(
String
sessionToken
,
List
<
Sample
>
samples
);
/**
/**
* Return all experiments of the given type that belong to the supplied projects. Available
* Return all experiments of the given type that belong to the supplied projects.
* since minor version 2.
*
*
* @param projects The projects for which we return attached experiments.
* @param projects The projects for which we return attached experiments.
* @param experimentType The experiment type of the experiments we want to list. Since version
* @param experimentType The experiment type of the experiments we want to list. Since version
...
@@ -196,7 +194,7 @@ public interface IGeneralInformationService extends IRpcService
...
@@ -196,7 +194,7 @@ public interface IGeneralInformationService extends IRpcService
/**
/**
* Return all experiments of the given type that belong to the supplied projects and have
* Return all experiments of the given type that belong to the supplied projects and have
* registered samles.
Available since minor version 15.
* registered samles.
*
*
* @param projects The projects for which we return attached experiments.
* @param projects The projects for which we return attached experiments.
* @param experimentType The experiment type of the experiments we want to list. Specifying a
* @param experimentType The experiment type of the experiments we want to list. Specifying a
...
@@ -209,7 +207,7 @@ public interface IGeneralInformationService extends IRpcService
...
@@ -209,7 +207,7 @@ public interface IGeneralInformationService extends IRpcService
/**
/**
* Return all experiments of the given type that belong to the supplied projects and have
* Return all experiments of the given type that belong to the supplied projects and have
* registered data sets.
Available since minor version 15.
* registered data sets.
*
*
* @param projects The projects for which we return attached experiments.
* @param projects The projects for which we return attached experiments.
* @param experimentType The experiment type of the experiments we want to list. Specifying a
* @param experimentType The experiment type of the experiments we want to list. Specifying a
...
@@ -223,7 +221,7 @@ public interface IGeneralInformationService extends IRpcService
...
@@ -223,7 +221,7 @@ public interface IGeneralInformationService extends IRpcService
/**
/**
* Return the data sets attached to the specified sample, optionally including child samples.
* Return the data sets attached to the specified sample, optionally including child samples.
* Note, that for returned container data sets the contained data sets have only code, type and
* Note, that for returned container data sets the contained data sets have only code, type and
* registration date set.
Available since minor version 3.
* registration date set.
*
*
* @param sample The sample for which we return attached data sets.
* @param sample The sample for which we return attached data sets.
* @param areOnlyDirectlyConnectedIncluded If true, only data sets that are directly connected
* @param areOnlyDirectlyConnectedIncluded If true, only data sets that are directly connected
...
@@ -235,8 +233,7 @@ public interface IGeneralInformationService extends IRpcService
...
@@ -235,8 +233,7 @@ public interface IGeneralInformationService extends IRpcService
boolean
areOnlyDirectlyConnectedIncluded
);
boolean
areOnlyDirectlyConnectedIncluded
);
/**
/**
* Returns the URL for the default data store server for this openBIS AS. Available since minor
* Returns the URL for the default data store server for this openBIS AS.
* version 4.
*
*
* @since 1.4
* @since 1.4
*/
*/
...
@@ -251,8 +248,7 @@ public interface IGeneralInformationService extends IRpcService
...
@@ -251,8 +248,7 @@ public interface IGeneralInformationService extends IRpcService
public
String
tryGetDataStoreBaseURL
(
String
sessionToken
,
String
dataSetCode
);
public
String
tryGetDataStoreBaseURL
(
String
sessionToken
,
String
dataSetCode
);
/**
/**
* Returns the URL for the default data store server for this openBIS AS. Available since minor
* Returns the URL for the default data store server for this openBIS AS.
* version 5.
*
*
* @since 1.5
* @since 1.5
*/
*/
...
@@ -281,8 +277,7 @@ public interface IGeneralInformationService extends IRpcService
...
@@ -281,8 +277,7 @@ public interface IGeneralInformationService extends IRpcService
String
sessionToken
);
String
sessionToken
);
/**
/**
* Return all data sets attached to the given samples with connections. Available since minor
* Return all data sets attached to the given samples with connections.
* version 7.
*
*
* @param samples The samples for which we return attached data sets.
* @param samples The samples for which we return attached data sets.
* @since 1.7
* @since 1.7
...
@@ -291,8 +286,7 @@ public interface IGeneralInformationService extends IRpcService
...
@@ -291,8 +286,7 @@ public interface IGeneralInformationService extends IRpcService
EnumSet
<
Connections
>
connectionsToGet
);
EnumSet
<
Connections
>
connectionsToGet
);
/**
/**
* Return all data sets attached to the given experiments with connections. Available since
* Return all data sets attached to the given experiments with connections.
* minor version 14.
*
*
* @param experiments The experiments for which we return attached data sets.
* @param experiments The experiments for which we return attached data sets.
* @since 1.14
* @since 1.14
...
@@ -304,7 +298,6 @@ public interface IGeneralInformationService extends IRpcService
...
@@ -304,7 +298,6 @@ public interface IGeneralInformationService extends IRpcService
* Returns meta data for all specified data sets. This contains data set type, properties, and
* Returns meta data for all specified data sets. This contains data set type, properties, and
* codes of linked parent and children data sets. For container data sets the contained data
* codes of linked parent and children data sets. For container data sets the contained data
* sets are not returned. Thus, {@link DataSet#getContainedDataSets()} is always empty.
* sets are not returned. Thus, {@link DataSet#getContainedDataSets()} is always empty.
* Available since minor version 12.
*
*
* @param dataSetCodes Codes of requested data sets.
* @param dataSetCodes Codes of requested data sets.
* @return result in the same order as the list of data set codes.
* @return result in the same order as the list of data set codes.
...
@@ -314,8 +307,7 @@ public interface IGeneralInformationService extends IRpcService
...
@@ -314,8 +307,7 @@ public interface IGeneralInformationService extends IRpcService
/**
/**
* Returns meta data for all specified data sets. Which parts of the data sets objects are
* Returns meta data for all specified data sets. Which parts of the data sets objects are
* fetched is controlled with the <code>fetchOptions</code> parameter. Available since minor
* fetched is controlled with the <code>fetchOptions</code> parameter.
* version 16.
*
*
* @param dataSetCodes Codes of requested data sets.
* @param dataSetCodes Codes of requested data sets.
* @param fetchOptions Options that control which parts of the data sets are fetched.
* @param fetchOptions Options that control which parts of the data sets are fetched.
...
@@ -327,8 +319,7 @@ public interface IGeneralInformationService extends IRpcService
...
@@ -327,8 +319,7 @@ public interface IGeneralInformationService extends IRpcService
/**
/**
* Return all data sets matching specified search criteria. Note, that for returned container
* Return all data sets matching specified search criteria. Note, that for returned container
* data sets the contained data sets have only code, type and registration date set. Available
* data sets the contained data sets have only code, type and registration date set.
* since minor version 8.
*
*
* @param searchCriteria the criteria used for searching.
* @param searchCriteria the criteria used for searching.
* @since 1.8
* @since 1.8
...
@@ -349,8 +340,7 @@ public interface IGeneralInformationService extends IRpcService
...
@@ -349,8 +340,7 @@ public interface IGeneralInformationService extends IRpcService
SearchCriteria
searchCriteria
,
String
userId
);
SearchCriteria
searchCriteria
,
String
userId
);
/**
/**
* Return all experiments matching a specified set of identifiers. Available since minor version
* Return all experiments matching a specified set of identifiers.
* 9.
*
*
* @param experimentIdentifiers the identifiers of the experiments to be returned.
* @param experimentIdentifiers the identifiers of the experiments to be returned.
* @since 1.9
* @since 1.9
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment