-
Notifications
You must be signed in to change notification settings - Fork 20
/
IGetResourceContents.cs
60 lines (56 loc) · 2.54 KB
/
IGetResourceContents.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
#region Disclaimer / License
// Copyright (C) 2010, Jackie Ng
// https://github.com/jumpinjackie/mapguide-maestro
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
//
#endregion Disclaimer / License
using OSGeo.MapGuide.ObjectModels;
using System.Collections.Generic;
namespace OSGeo.MapGuide.MaestroAPI.Commands
{
/// <summary>
/// Defines a command to get a set of resource contents in a single batch
/// </summary>
/// <example>
/// This example shows how invoke the <see cref="T:OSGeo.MapGuide.MaestroAPI.Commands.IGetResourceContents"/>
/// command. Note that you should check if the connection supports this command through its capabilities
/// <code>
/// <![CDATA[
/// IServerConnection conn;
/// ...
/// IGetResourceContents command = (IGetResourceContents)conn.CreateCommand(CommandType.GetResourceContents);
/// string [] resourceIds = new string[] {
/// "Library://Samples/Sheboygan/Layers/Parcels.LayerDefinition",
/// "Library://Samples/Sheboygan/Layers/Rail.LayerDefinition",
/// "Library://Samples/Sheboygan/Layers/HydrographicPolygons.LayerDefinition",
/// "Library://Samples/Sheboygan/Layers/CityLimits.LayerDefinition",
/// "Library://Samples/Sheboygan/Layers/Buildings.LayerDefinition",
/// "Library://Samples/Sheboygan/Layers/Roads.LayerDefinition"
/// };
/// Dictionary<string, IResource> results = command.Execute(resourceIds);
/// ]]>
/// </code>
/// </example>
public interface IGetResourceContents : ICommand
{
/// <summary>
/// Gets the resource content of the specified resources
/// </summary>
/// <param name="resourceIds"></param>
/// <returns></returns>
IDictionary<string, IResource> Execute(IEnumerable<string> resourceIds);
}
}