Coverage Report

Coverage Report - org.kuali.student.common.versionmanagement.service.VersionManagementService

Classes in this File

 package org.kuali.student.common.versionmanagement.service;
 
 import java.util.Date;
 import java.util.List;
 
 import javax.jws.WebParam;
 import javax.jws.WebService;
 import javax.jws.soap.SOAPBinding;
 
 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.versionmanagement.dto.VersionDisplayInfo;
 
 
 @WebService(name = "VersionManagementService", targetNamespace = "http://student.kuali.org/wsdl/versionmanagement")
 @SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED)
 public interface VersionManagementService {
 
     /**
      * Retrieves list of version associated with the objectId.
      * 
      * @param refObjectTypeURI
      *            reference object type URI 
      * @param refObjectId
      *            reference object Id
      * @return list of versions
      * @throws DoesNotExistException
      *             specified refObjectId, refObjectTypeURI not found
      * @throws InvalidParameterException
      *             invalid refObjectId, refObjectTypeURI
      * @throws MissingParameterException
      *            refObjectId, refObjectTypeURI not specified
      * @throws OperationFailedException
      *             unable to complete request
      * @throws PermissionDeniedException
      *             authorization failure
      */
     public List<VersionDisplayInfo> getVersions(@WebParam(name = "refObjectTypeURI") String refObjectTypeURI, @WebParam(name = "refObjectId") String refObjectId) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
     
 
     /**
      * Retrieves first version associated with the objectId.
      * 
      * @param refObjectTypeURI
      *            reference object type URI 
      * @param refObjectId
      *            reference object Id
      * @return first version
      * @throws DoesNotExistException
      *             specified refObjectId, refObjectTypeURI not found
      * @throws InvalidParameterException
      *             invalid refObjectId, refObjectTypeURI
      * @throws MissingParameterException
      *            refObjectId, refObjectTypeURI not specified
      * @throws OperationFailedException
      *             unable to complete request
      * @throws PermissionDeniedException
      *             authorization failure
      */
     public VersionDisplayInfo getFirstVersion(@WebParam(name = "refObjectTypeURI") String refObjectTypeURI, @WebParam(name = "refObjectId") String refObjectId) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 
     /**
          * Retrieves latest version associated with the objectId. This is not always the current version. 
          * A current version is what is being used by the system right now, but there could be draft version 
          * created after the current version.
      * 
      * @param refObjectTypeURI
      *            reference object type URI 
      * @param refObjectId
      *            reference object Id
      * @return current version
      * @throws DoesNotExistException
      *             specified refObjectId, refObjectTypeURI not found
      * @throws InvalidParameterException
      *             invalid refObjectId, refObjectTypeURI
      * @throws MissingParameterException
      *            refObjectId, refObjectTypeURI not specified
      * @throws OperationFailedException
      *             unable to complete request
      * @throws PermissionDeniedException
      *             authorization failure
      */
     public VersionDisplayInfo getLatestVersion(@WebParam(name = "refObjectTypeURI") String refObjectTypeURI, @WebParam(name = "refObjectId") String refObjectId) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
     
     
     /**
      * Retrieves current version associated with the objectId.
      * 
      * @param refObjectTypeURI
      *            reference object type URI 
      * @param refObjectId
      *            reference object Id
      * @return current version
      * @throws DoesNotExistException
      *             specified refObjectId, refObjectTypeURI not found
      * @throws InvalidParameterException
      *             invalid refObjectId, refObjectTypeURI
      * @throws MissingParameterException
      *            refObjectId, refObjectTypeURI not specified
      * @throws OperationFailedException
      *             unable to complete request
      * @throws PermissionDeniedException
      *             authorization failure
      */
     public VersionDisplayInfo getCurrentVersion(@WebParam(name = "refObjectTypeURI") String refObjectTypeURI, @WebParam(name = "refObjectId") String refObjectId) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 
 
     /**
      * Retrieves the version associated with the objectId and the sequence number.
      * 
      * @param refObjectTypeURI
      *            reference object type URI 
      * @param refObjectId
      *            reference object Id
      * @param sequence
      *            sequence number
      * @return version matching the sequence
      * @throws DoesNotExistException
      *             specified refObjectId, refObjectTypeURI, sequence not found
      * @throws InvalidParameterException
      *             invalid refObjectId, refObjectTypeURI, sequence
      * @throws MissingParameterException
      *            refObjectId, refObjectTypeURI, sequence not specified
      * @throws OperationFailedException
      *             unable to complete request
      * @throws PermissionDeniedException
      *             authorization failure
      */
     public VersionDisplayInfo getVersionBySequenceNumber(@WebParam(name = "refObjectTypeURI") String refObjectTypeURI, @WebParam(name = "refObjectId") String refObjectId, @WebParam(name = "sequence") Long sequence) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 
 
     /**
      * Retrieves the current version associated with the objectId on a given date.
      * 
      * @param refObjectTypeURI
      *            reference object type URI 
      * @param refObjectId
      *            reference object Id
      * @param date
      *            date
      * @return current version on date
      * @throws DoesNotExistException
      *             specified refObjectId, refObjectTypeURI not found
      * @throws InvalidParameterException
      *             invalid refObjectId, refObjectTypeURI, date
      * @throws MissingParameterException
      *            refObjectId, refObjectTypeURI, date not specified
      * @throws OperationFailedException
      *             unable to complete request
      * @throws PermissionDeniedException
      *             authorization failure
      */
     public VersionDisplayInfo getCurrentVersionOnDate(@WebParam(name = "refObjectTypeURI") String refObjectTypeURI, @WebParam(name = "refObjectId") String refObjectId, @WebParam(name = "date") Date date) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
 
 
     /**
      * Retrieves the current version associated with the objectId on a given date.
      * 
      * @param refObjectTypeURI
      *            reference object type URI 
      * @param refObjectId
      *            reference object Id
      * @param from
      *            from date
      * @param to
      *            to date
      * @return current version on date
      * @throws DoesNotExistException
      *             specified refObjectId, refObjectTypeURI not found
      * @throws InvalidParameterException
      *             invalid refObjectId, refObjectTypeURI, date
      * @throws MissingParameterException
      *            refObjectId, refObjectTypeURI, date not specified
      * @throws OperationFailedException
      *             unable to complete request
      * @throws PermissionDeniedException
      *             authorization failure
      */
     public List<VersionDisplayInfo> getVersionsInDateRange(@WebParam(name = "refObjectTypeURI") String refObjectTypeURI, @WebParam(name = "refObjectId") String refObjectId, @WebParam(name = "from") Date from, @WebParam(name = "to") Date to) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
    
 }

1		package org.kuali.student.common.versionmanagement.service;
2
3		import java.util.Date;
4		import java.util.List;
5
6		import javax.jws.WebParam;
7		import javax.jws.WebService;
8		import javax.jws.soap.SOAPBinding;
9
10		import org.kuali.student.common.exceptions.DoesNotExistException;
11		import org.kuali.student.common.exceptions.InvalidParameterException;
12		import org.kuali.student.common.exceptions.MissingParameterException;
13		import org.kuali.student.common.exceptions.OperationFailedException;
14		import org.kuali.student.common.exceptions.PermissionDeniedException;
15		import org.kuali.student.common.versionmanagement.dto.VersionDisplayInfo;
16
17
18		@WebService(name = "VersionManagementService", targetNamespace = "http://student.kuali.org/wsdl/versionmanagement")
19		@SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED)
20		public interface VersionManagementService {
21
22		/**
23		* Retrieves list of version associated with the objectId.
24		*
25		* @param refObjectTypeURI
26		* reference object type URI
27		* @param refObjectId
28		* reference object Id
29		* @return list of versions
30		* @throws DoesNotExistException
31		* specified refObjectId, refObjectTypeURI not found
32		* @throws InvalidParameterException
33		* invalid refObjectId, refObjectTypeURI
34		* @throws MissingParameterException
35		* refObjectId, refObjectTypeURI not specified
36		* @throws OperationFailedException
37		* unable to complete request
38		* @throws PermissionDeniedException
39		* authorization failure
40		*/
41		public List<VersionDisplayInfo> getVersions(@WebParam(name = "refObjectTypeURI") String refObjectTypeURI, @WebParam(name = "refObjectId") String refObjectId) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
42
43
44		/**
45		* Retrieves first version associated with the objectId.
46		*
47		* @param refObjectTypeURI
48		* reference object type URI
49		* @param refObjectId
50		* reference object Id
51		* @return first version
52		* @throws DoesNotExistException
53		* specified refObjectId, refObjectTypeURI not found
54		* @throws InvalidParameterException
55		* invalid refObjectId, refObjectTypeURI
56		* @throws MissingParameterException
57		* refObjectId, refObjectTypeURI not specified
58		* @throws OperationFailedException
59		* unable to complete request
60		* @throws PermissionDeniedException
61		* authorization failure
62		*/
63		public VersionDisplayInfo getFirstVersion(@WebParam(name = "refObjectTypeURI") String refObjectTypeURI, @WebParam(name = "refObjectId") String refObjectId) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
64
65		/**
66		* Retrieves latest version associated with the objectId. This is not always the current version.
67		* A current version is what is being used by the system right now, but there could be draft version
68		* created after the current version.
69		*
70		* @param refObjectTypeURI
71		* reference object type URI
72		* @param refObjectId
73		* reference object Id
74		* @return current version
75		* @throws DoesNotExistException
76		* specified refObjectId, refObjectTypeURI not found
77		* @throws InvalidParameterException
78		* invalid refObjectId, refObjectTypeURI
79		* @throws MissingParameterException
80		* refObjectId, refObjectTypeURI not specified
81		* @throws OperationFailedException
82		* unable to complete request
83		* @throws PermissionDeniedException
84		* authorization failure
85		*/
86		public VersionDisplayInfo getLatestVersion(@WebParam(name = "refObjectTypeURI") String refObjectTypeURI, @WebParam(name = "refObjectId") String refObjectId) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
87
88
89		/**
90		* Retrieves current version associated with the objectId.
91		*
92		* @param refObjectTypeURI
93		* reference object type URI
94		* @param refObjectId
95		* reference object Id
96		* @return current version
97		* @throws DoesNotExistException
98		* specified refObjectId, refObjectTypeURI not found
99		* @throws InvalidParameterException
100		* invalid refObjectId, refObjectTypeURI
101		* @throws MissingParameterException
102		* refObjectId, refObjectTypeURI not specified
103		* @throws OperationFailedException
104		* unable to complete request
105		* @throws PermissionDeniedException
106		* authorization failure
107		*/
108		public VersionDisplayInfo getCurrentVersion(@WebParam(name = "refObjectTypeURI") String refObjectTypeURI, @WebParam(name = "refObjectId") String refObjectId) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
109
110
111		/**
112		* Retrieves the version associated with the objectId and the sequence number.
113		*
114		* @param refObjectTypeURI
115		* reference object type URI
116		* @param refObjectId
117		* reference object Id
118		* @param sequence
119		* sequence number
120		* @return version matching the sequence
121		* @throws DoesNotExistException
122		* specified refObjectId, refObjectTypeURI, sequence not found
123		* @throws InvalidParameterException
124		* invalid refObjectId, refObjectTypeURI, sequence
125		* @throws MissingParameterException
126		* refObjectId, refObjectTypeURI, sequence not specified
127		* @throws OperationFailedException
128		* unable to complete request
129		* @throws PermissionDeniedException
130		* authorization failure
131		*/
132		public VersionDisplayInfo getVersionBySequenceNumber(@WebParam(name = "refObjectTypeURI") String refObjectTypeURI, @WebParam(name = "refObjectId") String refObjectId, @WebParam(name = "sequence") Long sequence) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
133
134
135		/**
136		* Retrieves the current version associated with the objectId on a given date.
137		*
138		* @param refObjectTypeURI
139		* reference object type URI
140		* @param refObjectId
141		* reference object Id
142		* @param date
143		* date
144		* @return current version on date
145		* @throws DoesNotExistException
146		* specified refObjectId, refObjectTypeURI not found
147		* @throws InvalidParameterException
148		* invalid refObjectId, refObjectTypeURI, date
149		* @throws MissingParameterException
150		* refObjectId, refObjectTypeURI, date not specified
151		* @throws OperationFailedException
152		* unable to complete request
153		* @throws PermissionDeniedException
154		* authorization failure
155		*/
156		public VersionDisplayInfo getCurrentVersionOnDate(@WebParam(name = "refObjectTypeURI") String refObjectTypeURI, @WebParam(name = "refObjectId") String refObjectId, @WebParam(name = "date") Date date) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
157
158
159		/**
160		* Retrieves the current version associated with the objectId on a given date.
161		*
162		* @param refObjectTypeURI
163		* reference object type URI
164		* @param refObjectId
165		* reference object Id
166		* @param from
167		* from date
168		* @param to
169		* to date
170		* @return current version on date
171		* @throws DoesNotExistException
172		* specified refObjectId, refObjectTypeURI not found
173		* @throws InvalidParameterException
174		* invalid refObjectId, refObjectTypeURI, date
175		* @throws MissingParameterException
176		* refObjectId, refObjectTypeURI, date not specified
177		* @throws OperationFailedException
178		* unable to complete request
179		* @throws PermissionDeniedException
180		* authorization failure
181		*/
182		public List<VersionDisplayInfo> getVersionsInDateRange(@WebParam(name = "refObjectTypeURI") String refObjectTypeURI, @WebParam(name = "refObjectId") String refObjectId, @WebParam(name = "from") Date from, @WebParam(name = "to") Date to) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException;
183
184		}