View Javadoc

1   /**
2    * Copyright 2005-2011 The Kuali Foundation
3    *
4    * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
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, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.kuali.rice.core.api.namespace;
17  
18  import org.kuali.rice.core.api.CoreConstants;
19  import org.kuali.rice.core.api.exception.RiceIllegalArgumentException;
20  
21  import javax.jws.WebMethod;
22  import javax.jws.WebParam;
23  import javax.jws.WebResult;
24  import javax.jws.WebService;
25  import javax.jws.soap.SOAPBinding;
26  
27  @WebService(name = "namespaceService", targetNamespace = CoreConstants.Namespaces.CORE_NAMESPACE_2_0)
28  @SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED)
29  public interface NamespaceService {
30  
31      /**
32       * Gets a {@link Namespace} from a namespace code.
33       *
34       * <p>
35       *   This method will return null if the namespace does not exist.
36       * </p>
37       *
38       * @param code the code to retrieve the namespace by. cannot be blank.
39       * @return a {@link Namespace} or null
40       * @throws IllegalArgumentException if the code is blank
41       */
42      @WebMethod(operationName="getNamespace")
43      @WebResult(name = "namespace")
44  	Namespace getNamespace(@WebParam(name = "code") String code) throws RiceIllegalArgumentException;
45  }