Coverage Report

Coverage Report - org.kuali.student.r2.lum.classI.lrc.service.LRCService

Classes in this File

 /**
  * Copyright 2010 The Kuali Foundation Licensed under the
  * Educational Community License, Version 2.0 (the "License"); you may
  * not use this file except in compliance with the License. You may
  * obtain a copy of the License at
  *
  * http://www.osedu.org/licenses/ECL-2.0
  *
  * Unless required by applicable law or agreed to in writing,
  * software distributed under the License is distributed on an "AS IS"
  * BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
  * or implied. See the License for the specific language governing
  * permissions and limitations under the License.
  */
 
 package org.kuali.student.r2.lum.classI.lrc.service;
 
 import java.util.List;
 
 import javax.jws.WebParam;
 import javax.jws.WebService;
 import javax.jws.soap.SOAPBinding;
 
 
 import org.kuali.student.common.dto.StatusInfo;
 import org.kuali.student.common.exceptions.AlreadyExistsException;
 import org.kuali.student.common.exceptions.DataValidationErrorException;
 import org.kuali.student.common.exceptions.DoesNotExistException;
 import org.kuali.student.common.exceptions.InvalidParameterException;
 import org.kuali.student.common.exceptions.MissingParameterException;
 import org.kuali.student.common.exceptions.OperationFailedException;
 import org.kuali.student.common.exceptions.PermissionDeniedException;
 import org.kuali.student.common.exceptions.VersionMismatchException;
 
 
 import org.kuali.student.r2.common.datadictionary.service.DataDictionaryService;
 import org.kuali.student.r2.common.service.StateService;
 import org.kuali.student.r2.common.service.TypeService;
 import org.kuali.student.r2.lum.classI.lrc.dto.ResultValueGroupInfo;
 import org.kuali.student.r2.lum.classI.lrc.dto.ResultValueGroupTypeInfo;
 import org.kuali.student.r2.lum.classI.lrc.dto.ResultValueInfo;
 
 /**
  *
  * @Author KSContractMojo
  * @Author lindholm
  * @Since Tue Apr 21 14:09:46 PDT 2009
  * @See <a href="https://test.kuali.org/confluence/display/KULSTU/Learning+Result+Catalog+Service">LrcService</>
  *
  */
 @WebService(name = "LrcService", targetNamespace = "http://student.kuali.org/wsdl/lrc")
 @SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED)
 public interface LRCService extends DataDictionaryService, TypeService, StateService {
     /**
      * Retrieves information on all result types.
      * @return list of result type information
      * @throws OperationFailedException unable to complete request
          */
     public List<ResultValueGroupTypeInfo> getResultTypes() throws OperationFailedException;
 
     /**
      * Retrieves information on a specific result type.
      * @param credentialTypeKey identifier for the credential type
      * @return information about a credential type
      * @throws DoesNotExistException resultTypeKey not found
      * @throws InvalidParameterException invalid resultTypeKey
      * @throws MissingParameterException missing resultTypeKey
      * @throws OperationFailedException unable to complete request
          */
     public ResultValueGroupTypeInfo getResultType(@WebParam(name="resultTypeKey")String resultTypeKey) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
 
     /**
      * Retrieves a list of existing credentials by a list of identifiers.
      * @param credentialKeyList identifiers for credentials to be retrieved
      * @return details of the credentials for these ids
      * @throws DoesNotExistException credentialKey not found
      * @throws InvalidParameterException invalid credentialKeyList
      * @throws MissingParameterException invalid credentialKeyList
      * @throws OperationFailedException unable to complete request
          */
     public ResultValueInfo getResult(@WebParam(name="resultKey")String resultKey) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
 
     /**
      * Retrieves a list of existing credentials by a list of identifiers.
      * @param credentialKeyList identifiers for credentials to be retrieved
      * @return details of the credentials for these ids
      * @throws DoesNotExistException credentialKey not found
      * @throws InvalidParameterException invalid credentialKeyList
      * @throws MissingParameterException invalid credentialKeyList
      * @throws OperationFailedException unable to complete request
          */
     public List<ResultValueInfo> getResultsByKeyList(@WebParam(name="resultKeyList")List<String> resultKeyList) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
 
     /**
      * Retrieves a list of credential identifiers for a specified credential type.
      * @param credentialTypeKey identifier for the credential type
      * @return list of credential identifiers
      * @throws DoesNotExistException credentialTypeKey not found
      * @throws InvalidParameterException invalid credentialTypeKey
      * @throws MissingParameterException missing credentialTypeKey
      * @throws OperationFailedException unable to complete request
          */
     public List<String> getResultKeysByResultType(@WebParam(name="resultTypeKey")String resultTypeKey) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
 
    
    
     /**
      * Retrieves information on a specific result component.
      * @param resultComponentId result component identifier
      * @return information about a result component
      * @throws DoesNotExistException resultComponentId not found
      * @throws InvalidParameterException invalid resultComponentId
      * @throws MissingParameterException missing resultComponentId
      * @throws OperationFailedException unable to complete request
          */
     public ResultValueGroupInfo getResultComponent(@WebParam(name="resultComponentId")String resultComponentId) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
 
     /**
      * Retrieves a list of result component identifiers for a specified result component type.
      * @param resultComponentTypeKey identifier for the result component type
      * @return list of result component identifiers
      * @throws DoesNotExistException resultComponentTypeKey not found
      * @throws InvalidParameterException invalid resultComponentTypeKey
      * @throws MissingParameterException missing resultComponentTypeKey
      * @throws OperationFailedException unable to complete request
          */
     public List<String> getResultComponentIdsByResultComponentType(@WebParam(name="resultComponentTypeKey")String resultComponentTypeKey) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
 
     /**
      * Retrieves a list of result component identifiers for a specified result. The result component type is specified as well to provide an indication of the id space.
      * @param resultValueId identifier for the result value
      * @param resultComponentTypeKey identifier for the result component type
      * @return list of result component identifiers
      * @throws DoesNotExistException resultValueId, resultComponentTypeKey not found
      * @throws InvalidParameterException invalid resultValueId, resultComponentTypeKey
      * @throws MissingParameterException missing resultValueId, resultComponentTypeKey
      * @throws OperationFailedException unable to complete request
          */
     public List<String> getResultComponentIdsByResult(@WebParam(name="resultValueId")String resultValueId, @WebParam(name="resultComponentTypeKey")String resultComponentTypeKey) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
 
     /**
      * Creates a new result component.
      * @param resultComponentTypeKey identifier of the result component type
      * @param resultComponentInfo information about the result component being created
      * @return create result component information
      * @throws AlreadyExistsException result component already exists
      * @throws DataValidationErrorException one or more values invalid for this operation
      * @throws DoesNotExistException resultComponentTypeKey not found
      * @throws InvalidParameterException invalid resultComponentTypeKey, resultComponentInfo
      * @throws MissingParameterException missing resultComponentTypeKey, resultComponentInfo
      * @throws OperationFailedException unable to complete request
      * @throws PermissionDeniedException authorization failure
          */
     public ResultValueGroupInfo createResultComponent(@WebParam(name="resultComponentTypeKey")String resultComponentTypeKey, @WebParam(name="resultComponentInfo")ResultValueGroupInfo resultComponentInfo) throws AlreadyExistsException, DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 
     /**
      * Updates an existing result component.
      * @param resultComponentId identifier of the result component to update
      * @param resultComponentInfo updated information about the result component
      * @return updated result component information
      * @throws DataValidationErrorException one or more values invalid for this operation
      * @throws DoesNotExistException resultComponentId not found
      * @throws InvalidParameterException invalid resultComponentId, resultComponentInfo
      * @throws MissingParameterException missing resultComponentId, resultComponentInfo
      * @throws OperationFailedException unable to complete request
      * @throws PermissionDeniedException authorization failure
      * @throws VersionMismatchException action was attempted on an out of date version.
          */
     public ResultValueGroupInfo updateResultComponent(@WebParam(name="resultComponentId")String resultComponentId, @WebParam(name="resultComponentInfo")ResultValueGroupInfo resultComponentInfo) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, VersionMismatchException;
 
     /**
      * Deletes an existing result component.
      * @param resultComponentId identifier of the result component to update
      * @return status of the operation
      * @throws DoesNotExistException resultComponentId not found
      * @throws InvalidParameterException invalid resultComponentId
      * @throws MissingParameterException missing resultComponentId
      * @throws OperationFailedException unable to complete request
      * @throws PermissionDeniedException authorization failure
          */
     public StatusInfo deleteResultComponent(@WebParam(name="resultComponentId")String resultComponentId) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 
 }

1		/**
2		* Copyright 2010 The Kuali Foundation Licensed under the
3		* Educational Community License, Version 2.0 (the "License"); you may
4		* not use this file except in compliance with the License. You may
5		* obtain a copy of the License at
6		*
7		* http://www.osedu.org/licenses/ECL-2.0
8		*
9		* Unless required by applicable law or agreed to in writing,
10		* software distributed under the License is distributed on an "AS IS"
11		* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
12		* or implied. See the License for the specific language governing
13		* permissions and limitations under the License.
14		*/
15
16		package org.kuali.student.r2.lum.classI.lrc.service;
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		import org.kuali.student.common.dto.StatusInfo;
26		import org.kuali.student.common.exceptions.AlreadyExistsException;
27		import org.kuali.student.common.exceptions.DataValidationErrorException;
28		import org.kuali.student.common.exceptions.DoesNotExistException;
29		import org.kuali.student.common.exceptions.InvalidParameterException;
30		import org.kuali.student.common.exceptions.MissingParameterException;
31		import org.kuali.student.common.exceptions.OperationFailedException;
32		import org.kuali.student.common.exceptions.PermissionDeniedException;
33		import org.kuali.student.common.exceptions.VersionMismatchException;
34
35
36		import org.kuali.student.r2.common.datadictionary.service.DataDictionaryService;
37		import org.kuali.student.r2.common.service.StateService;
38		import org.kuali.student.r2.common.service.TypeService;
39		import org.kuali.student.r2.lum.classI.lrc.dto.ResultValueGroupInfo;
40		import org.kuali.student.r2.lum.classI.lrc.dto.ResultValueGroupTypeInfo;
41		import org.kuali.student.r2.lum.classI.lrc.dto.ResultValueInfo;
42
43		/**
44		*
45		* @Author KSContractMojo
46		* @Author lindholm
47		* @Since Tue Apr 21 14:09:46 PDT 2009
48		* @See <a href="https://test.kuali.org/confluence/display/KULSTU/Learning+Result+Catalog+Service">LrcService</>
49		*
50		*/
51		@WebService(name = "LrcService", targetNamespace = "http://student.kuali.org/wsdl/lrc")
52		@SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED)
53		public interface LRCService extends DataDictionaryService, TypeService, StateService {
54		/**
55		* Retrieves information on all result types.
56		* @return list of result type information
57		* @throws OperationFailedException unable to complete request
58		*/
59		public List<ResultValueGroupTypeInfo> getResultTypes() throws OperationFailedException;
60
61		/**
62		* Retrieves information on a specific result type.
63		* @param credentialTypeKey identifier for the credential type
64		* @return information about a credential type
65		* @throws DoesNotExistException resultTypeKey not found
66		* @throws InvalidParameterException invalid resultTypeKey
67		* @throws MissingParameterException missing resultTypeKey
68		* @throws OperationFailedException unable to complete request
69		*/
70		public ResultValueGroupTypeInfo getResultType(@WebParam(name="resultTypeKey")String resultTypeKey) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
71
72		/**
73		* Retrieves a list of existing credentials by a list of identifiers.
74		* @param credentialKeyList identifiers for credentials to be retrieved
75		* @return details of the credentials for these ids
76		* @throws DoesNotExistException credentialKey not found
77		* @throws InvalidParameterException invalid credentialKeyList
78		* @throws MissingParameterException invalid credentialKeyList
79		* @throws OperationFailedException unable to complete request
80		*/
81		public ResultValueInfo getResult(@WebParam(name="resultKey")String resultKey) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
82
83		/**
84		* Retrieves a list of existing credentials by a list of identifiers.
85		* @param credentialKeyList identifiers for credentials to be retrieved
86		* @return details of the credentials for these ids
87		* @throws DoesNotExistException credentialKey not found
88		* @throws InvalidParameterException invalid credentialKeyList
89		* @throws MissingParameterException invalid credentialKeyList
90		* @throws OperationFailedException unable to complete request
91		*/
92		public List<ResultValueInfo> getResultsByKeyList(@WebParam(name="resultKeyList")List<String> resultKeyList) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
93
94		/**
95		* Retrieves a list of credential identifiers for a specified credential type.
96		* @param credentialTypeKey identifier for the credential type
97		* @return list of credential identifiers
98		* @throws DoesNotExistException credentialTypeKey not found
99		* @throws InvalidParameterException invalid credentialTypeKey
100		* @throws MissingParameterException missing credentialTypeKey
101		* @throws OperationFailedException unable to complete request
102		*/
103		public List<String> getResultKeysByResultType(@WebParam(name="resultTypeKey")String resultTypeKey) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
104
105
106
107		/**
108		* Retrieves information on a specific result component.
109		* @param resultComponentId result component identifier
110		* @return information about a result component
111		* @throws DoesNotExistException resultComponentId not found
112		* @throws InvalidParameterException invalid resultComponentId
113		* @throws MissingParameterException missing resultComponentId
114		* @throws OperationFailedException unable to complete request
115		*/
116		public ResultValueGroupInfo getResultComponent(@WebParam(name="resultComponentId")String resultComponentId) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
117
118		/**
119		* Retrieves a list of result component identifiers for a specified result component type.
120		* @param resultComponentTypeKey identifier for the result component type
121		* @return list of result component identifiers
122		* @throws DoesNotExistException resultComponentTypeKey not found
123		* @throws InvalidParameterException invalid resultComponentTypeKey
124		* @throws MissingParameterException missing resultComponentTypeKey
125		* @throws OperationFailedException unable to complete request
126		*/
127		public List<String> getResultComponentIdsByResultComponentType(@WebParam(name="resultComponentTypeKey")String resultComponentTypeKey) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
128
129		/**
130		* Retrieves a list of result component identifiers for a specified result. The result component type is specified as well to provide an indication of the id space.
131		* @param resultValueId identifier for the result value
132		* @param resultComponentTypeKey identifier for the result component type
133		* @return list of result component identifiers
134		* @throws DoesNotExistException resultValueId, resultComponentTypeKey not found
135		* @throws InvalidParameterException invalid resultValueId, resultComponentTypeKey
136		* @throws MissingParameterException missing resultValueId, resultComponentTypeKey
137		* @throws OperationFailedException unable to complete request
138		*/
139		public List<String> getResultComponentIdsByResult(@WebParam(name="resultValueId")String resultValueId, @WebParam(name="resultComponentTypeKey")String resultComponentTypeKey) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException;
140
141		/**
142		* Creates a new result component.
143		* @param resultComponentTypeKey identifier of the result component type
144		* @param resultComponentInfo information about the result component being created
145		* @return create result component information
146		* @throws AlreadyExistsException result component already exists
147		* @throws DataValidationErrorException one or more values invalid for this operation
148		* @throws DoesNotExistException resultComponentTypeKey not found
149		* @throws InvalidParameterException invalid resultComponentTypeKey, resultComponentInfo
150		* @throws MissingParameterException missing resultComponentTypeKey, resultComponentInfo
151		* @throws OperationFailedException unable to complete request
152		* @throws PermissionDeniedException authorization failure
153		*/
154		public ResultValueGroupInfo createResultComponent(@WebParam(name="resultComponentTypeKey")String resultComponentTypeKey, @WebParam(name="resultComponentInfo")ResultValueGroupInfo resultComponentInfo) throws AlreadyExistsException, DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
155
156		/**
157		* Updates an existing result component.
158		* @param resultComponentId identifier of the result component to update
159		* @param resultComponentInfo updated information about the result component
160		* @return updated result component information
161		* @throws DataValidationErrorException one or more values invalid for this operation
162		* @throws DoesNotExistException resultComponentId not found
163		* @throws InvalidParameterException invalid resultComponentId, resultComponentInfo
164		* @throws MissingParameterException missing resultComponentId, resultComponentInfo
165		* @throws OperationFailedException unable to complete request
166		* @throws PermissionDeniedException authorization failure
167		* @throws VersionMismatchException action was attempted on an out of date version.
168		*/
169		public ResultValueGroupInfo updateResultComponent(@WebParam(name="resultComponentId")String resultComponentId, @WebParam(name="resultComponentInfo")ResultValueGroupInfo resultComponentInfo) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, VersionMismatchException;
170
171		/**
172		* Deletes an existing result component.
173		* @param resultComponentId identifier of the result component to update
174		* @return status of the operation
175		* @throws DoesNotExistException resultComponentId not found
176		* @throws InvalidParameterException invalid resultComponentId
177		* @throws MissingParameterException missing resultComponentId
178		* @throws OperationFailedException unable to complete request
179		* @throws PermissionDeniedException authorization failure
180		*/
181		public StatusInfo deleteResultComponent(@WebParam(name="resultComponentId")String resultComponentId) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
182
183		}