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.kew.api.preferences;
17  
18  import org.kuali.rice.kew.api.KewApiConstants;
19  
20  import javax.jws.WebMethod;
21  import javax.jws.WebParam;
22  import javax.jws.WebResult;
23  import javax.jws.WebService;
24  import javax.jws.soap.SOAPBinding;
25  
26  import org.springframework.cache.annotation.Cacheable;
27  
28  import org.kuali.rice.kew.api.KewApiConstants;
29  import org.kuali.rice.kew.api.preferences.Preferences;
30  
31  /**
32   * A service which provides data access for {@link Preferences}.
33   *
34   * @see Preferences
35   *
36   * @author Kuali Rice Team (rice.collab@kuali.org)
37   */
38  @WebService(name = "preferencesService", targetNamespace = KewApiConstants.Namespaces.KEW_NAMESPACE_2_0)
39  @SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED)
40  public interface PreferencesService {
41  
42      @WebMethod(operationName = "savePreferences")
43      public void savePreferences(@WebParam(name="principalId") String principalId, @WebParam(name="preferences") Preferences actionListPreferences);
44  
45      @WebMethod(operationName = "getPreferences")
46      @WebResult(name = "preferences")
47      //@Cacheable(value= Preferences.Cache.NAME, key="'principalId=' + #principalId")
48      public Preferences getPreferences(@WebParam(name="principalId") String principalId);
49  
50  }