View Javadoc

1   /*
2    * Copyright 2004-2008 the Seasar Foundation and the Others.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, 
13   * either express or implied. See the License for the specific language
14   * governing permissions and limitations under the License.
15   */
16  package org.seasar.uruma.rcp.binding;
17  
18  import java.util.List;
19  
20  import org.seasar.uruma.rcp.UrumaService;
21  
22  /**
23   * コマンドの定義情報を管理するためのインターフェースです。<br />
24   * 本インターフェースの実装クラスは、 {@link UrumaService#getCommandRegistry()}
25   * メソッドを利用して取得してください。<br />
26   * 
27   * @author y-komori
28   */
29  public interface CommandRegistry {
30  
31      /**
32       * {@link CommandDesc} を登録します。<br />
33       * 
34       * @param desc
35       *            {@link CommandDesc} オブジェクト
36       */
37      public void registerCommandDesc(final CommandDesc desc);
38  
39      /**
40       * {@link CommandDesc} のリストを返します。<br />
41       * 
42       * @return {@link CommandDesc} のリスト
43       */
44      public List<CommandDesc> getCommandDescs();
45  
46      /**
47       * 指定された <code>commandId</code> を持つ {@link CommandDesc} を返します。<br />
48       * 
49       * @param commandId
50       *            コマンドID
51       * @return {@link CommandDesc} オブジェクト。見つからなかった場合は <code>null</code>。
52       */
53      public CommandDesc getCommandDesc(final String commandId);
54  
55  }