getDatasetCommentAnnotations.m

function cas = getDatasetCommentAnnotations(session, ids, varargin)
% GETDATASETCOMMENTANNOTATIONS Retrieve comment annotations linked to datasets
%
%    cas = getDatasetCommentAnnotations(session, ids) returns all comment
%    annotations linked to the datasets specified by the input identifiers
%    and owned by the session user.
%
%    cas = getDatasetCommentAnnotations(session, datasets) returns all
%    comment annotations linked to the input datasets and owned by the
%    session user.
%
%    cas = getDatasetCommentAnnotations(session,  ids, 'include', include)
%    only returns comment annotations with the input namespace.
%
%    cas = getDatasetCommentAnnotations(session,  ids, 'exclude', exclude)
%    excludes comment annotations with the input namespace.
%
%    Examples:
%
%        cas = getDatasetCommentAnnotations(session, ids)
%        cas = getDatasetCommentAnnotations(session, datasets)
%        cas = getDatasetCommentAnnotations(session, ids, 'include', include)
%        cas = getDatasetCommentAnnotations(session, ids, 'exclude', exclude)
%
% See also: GETOBJECTANNOTATIONS, GETDATASETFILEANNOTATIONS,
% GETDATASETTAGANNOTATIONS, GETDATASETXMLANNOTATIONS

% Copyright (C) 2013 University of Dundee & Open Microscopy Environment.
% All rights reserved.
%
% This program is free software; you can redistribute it and/or modify
% it under the terms of the GNU General Public License as published by
% the Free Software Foundation; either version 2 of the License, or
% (at your option) any later version.
%
% This program is distributed in the hope that it will be useful,
% but WITHOUT ANY WARRANTY; without even the implied warranty of
% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
% GNU General Public License for more details.
%
% You should have received a copy of the GNU General Public License along
% with this program; if not, write to the Free Software Foundation, Inc.,
% 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

cas = getObjectAnnotations(session, 'comment', 'dataset', ids, varargin{:});