View Javadoc

1   /**
2    * Copyright 2004-2013 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.student.contract.model.test.source;
17  
18  import java.util.List;
19  
20  import javax.jws.WebParam;
21  import javax.jws.WebService;
22  import javax.jws.soap.SOAPBinding;
23  
24  
25  /**
26   * ATp service
27   * 
28   * @version 1.0 (Dev)
29   *
30   * @Author Kamal
31   * @Since Tue Mar 01 15:53:51 PST 2011
32   * @See <a href="https://wiki.kuali.org/display/KULSTU/LUI+Person+Relation+Service">LuiPersonRelationService</>
33   */
34  @WebService(name = "AtpService", targetNamespace = "http://student.kuali.org/wsdl/atp")
35  @SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED)
36  public interface AtpService extends TypeService, StateService {
37  
38      /**
39       * Retrieves the atp
40       *
41       * @param atpKey Identifier for the ATP Person Relation
42       * @param context             Context information containing the principalId and locale information about the caller of service operation
43       * @return atp information
44       * @throws DoesNotExistException     luiPersonRelationId not found
45       * @throws InvalidParameterException invalid luiPersonRelationId
46       * @throws MissingParameterException missing luiPersonRelationId
47       * @throws OperationFailedException  unable to complete request
48       * @throws PermissionDeniedException authorization failure
49       * @impl this is an implementation note
50       * @impl this is another
51       */
52      public AtpInfo getAtp(@WebParam(name = "atpKey") String atpKey, @WebParam(name = "context") ContextInfo context) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
53  }