| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_111) on Wed Jan 25 23:58:41 NOVT 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>CalendarWebService (Openmeetings Webservices 3.1.5 API)</title> |
| <meta name="date" content="2017-01-25"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="CalendarWebService (Openmeetings Webservices 3.1.5 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/CalendarWebService.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../org/apache/openmeetings/webservice/Constants.html" title="class in org.apache.openmeetings.webservice"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openmeetings/webservice/CalendarWebService.html" target="_top">Frames</a></li> |
| <li><a href="CalendarWebService.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.openmeetings.webservice</div> |
| <h2 title="Class CalendarWebService" class="title">Class CalendarWebService</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.openmeetings.webservice.CalendarWebService</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>@Produces(value="application/json") |
| @Path(value="/calendar") |
| public class <span class="typeNameLabel">CalendarWebService</span> |
| extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">CalendarService contains methods to create, edit delete calendar meetings</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>sebawagner</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/openmeetings/webservice/CalendarWebService.html#CalendarWebService--">CalendarWebService</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.basic">ServiceResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openmeetings/webservice/CalendarWebService.html#delete-java.lang.String-java.lang.Long-">delete</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sid, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> id)</code> |
| <div class="block">delete a calendar event |
| |
| If the given SID is from an Administrator or Web-Service user, the user |
| can delete any appointment.<br/> |
| If the SID is assigned to a simple user, he can only delete appointments |
| where he is also the owner/creator of the appointment</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/calendar/AppointmentDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.calendar">AppointmentDTO</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openmeetings/webservice/CalendarWebService.html#getByRoom-java.lang.String-long-">getByRoom</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sid, |
| long roomid)</code> |
| <div class="block">Load a calendar event by its room id</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/calendar/AppointmentDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.calendar">AppointmentDTO</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openmeetings/webservice/CalendarWebService.html#getByTitle-java.lang.String-java.lang.String-">getByTitle</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sid, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> title)</code> |
| <div class="block">Search a calendar event for the current SID</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/calendar/AppointmentDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.calendar">AppointmentDTO</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openmeetings/webservice/CalendarWebService.html#next-java.lang.String-">next</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sid)</code> |
| <div class="block">Get the next Calendar event for the current user of the SID</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/calendar/AppointmentDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.calendar">AppointmentDTO</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openmeetings/webservice/CalendarWebService.html#nextForUser-java.lang.String-long-">nextForUser</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sid, |
| long userid)</code> |
| <div class="block">Get the next Calendar event for userId</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/calendar/AppointmentDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.calendar">AppointmentDTO</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openmeetings/webservice/CalendarWebService.html#range-java.lang.String-java.util.Calendar-java.util.Calendar-">range</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sid, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</a> start, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</a> end)</code> |
| <div class="block">Load appointments by a start / end range for the current SID</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/calendar/AppointmentDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.calendar">AppointmentDTO</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openmeetings/webservice/CalendarWebService.html#rangeForUser-java.lang.String-long-java.util.Calendar-java.util.Calendar-">rangeForUser</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sid, |
| long userid, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</a> start, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</a> end)</code> |
| <div class="block">Load appointments by a start / end range for the userId</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/calendar/AppointmentDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.calendar">AppointmentDTO</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openmeetings/webservice/CalendarWebService.html#save-java.lang.String-org.apache.openmeetings.db.dto.calendar.AppointmentDTO-">save</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sid, |
| <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/calendar/AppointmentDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.calendar">AppointmentDTO</a> appointment)</code> |
| <div class="block">Save an appointment</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="CalendarWebService--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CalendarWebService</h4> |
| <pre>public CalendarWebService()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="range-java.lang.String-java.util.Calendar-java.util.Calendar-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>range</h4> |
| <pre>@GET |
| @Path(value="/{start}/{end}") |
| public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/calendar/AppointmentDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.calendar">AppointmentDTO</a>> range(@QueryParam(value="sid") |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sid, |
| @PathParam(value="start") |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</a> start, |
| @PathParam(value="end") |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</a> end) |
| throws <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.error.ServiceException.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.error.ServiceException</a></pre> |
| <div class="block">Load appointments by a start / end range for the current SID</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sid</code> - The SID of the User. This SID must be marked as Loggedin</dd> |
| <dd><code>start</code> - start time</dd> |
| <dd><code>end</code> - end time</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>- list of appointments in range</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>{@link</code> - ServiceException} in case of any error</dd> |
| <dd><code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.error.ServiceException.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.error.ServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="rangeForUser-java.lang.String-long-java.util.Calendar-java.util.Calendar-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rangeForUser</h4> |
| <pre>@GET |
| @Path(value="/{userid}/{start}/{end}") |
| public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/calendar/AppointmentDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.calendar">AppointmentDTO</a>> rangeForUser(@QueryParam(value="sid") |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sid, |
| @PathParam(value="userid") |
| long userid, |
| @PathParam(value="start") |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</a> start, |
| @PathParam(value="end") |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</a> end) |
| throws <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.error.ServiceException.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.error.ServiceException</a></pre> |
| <div class="block">Load appointments by a start / end range for the userId</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sid</code> - The SID of the User. This SID must be marked as Loggedin</dd> |
| <dd><code>userid</code> - the userId the calendar events should be loaded</dd> |
| <dd><code>start</code> - start time</dd> |
| <dd><code>end</code> - end time</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>- list of appointments in range</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>{@link</code> - ServiceException} in case of any error</dd> |
| <dd><code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.error.ServiceException.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.error.ServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="next-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>next</h4> |
| <pre>@GET |
| @Path(value="/next") |
| public <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/calendar/AppointmentDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.calendar">AppointmentDTO</a> next(@QueryParam(value="sid") |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sid) |
| throws <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.error.ServiceException.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.error.ServiceException</a></pre> |
| <div class="block">Get the next Calendar event for the current user of the SID</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sid</code> - The SID of the User. This SID must be marked as Loggedin</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>- next Calendar event</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>{@link</code> - ServiceException} in case of any error</dd> |
| <dd><code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.error.ServiceException.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.error.ServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="nextForUser-java.lang.String-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nextForUser</h4> |
| <pre>@GET |
| @Path(value="/next/{userid}") |
| public <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/calendar/AppointmentDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.calendar">AppointmentDTO</a> nextForUser(@QueryParam(value="sid") |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sid, |
| @PathParam(value="userid") |
| long userid) |
| throws <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.error.ServiceException.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.error.ServiceException</a></pre> |
| <div class="block">Get the next Calendar event for userId</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sid</code> - The SID of the User. This SID must be marked as Loggedin</dd> |
| <dd><code>userid</code> - the userId the calendar events should be loaded</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>- next Calendar event</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>{@link</code> - ServiceException} in case of any error</dd> |
| <dd><code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.error.ServiceException.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.error.ServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getByRoom-java.lang.String-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getByRoom</h4> |
| <pre>@GET |
| @Path(value="/room/{roomid}") |
| public <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/calendar/AppointmentDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.calendar">AppointmentDTO</a> getByRoom(@QueryParam(value="sid") |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sid, |
| @PathParam(value="roomid") |
| long roomid) |
| throws <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.error.ServiceException.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.error.ServiceException</a></pre> |
| <div class="block">Load a calendar event by its room id</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sid</code> - </dd> |
| <dd><code>roomid</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>- calendar event by its room id</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>{@link</code> - ServiceException} in case of any error</dd> |
| <dd><code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.error.ServiceException.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.error.ServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getByTitle-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getByTitle</h4> |
| <pre>@GET |
| @Path(value="/title/{title}") |
| public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/calendar/AppointmentDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.calendar">AppointmentDTO</a>> getByTitle(@QueryParam(value="sid") |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sid, |
| @PathParam(value="title") |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> title) |
| throws <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.error.ServiceException.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.error.ServiceException</a></pre> |
| <div class="block">Search a calendar event for the current SID</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sid</code> - The SID of the User. This SID must be marked as Loggedin</dd> |
| <dd><code>title</code> - the search string</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>- calendar event list</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>{@link</code> - ServiceException} in case of any error</dd> |
| <dd><code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.error.ServiceException.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.error.ServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="save-java.lang.String-org.apache.openmeetings.db.dto.calendar.AppointmentDTO-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>save</h4> |
| <pre>@POST |
| @Path(value="/") |
| public <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/calendar/AppointmentDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.calendar">AppointmentDTO</a> save(@QueryParam(value="sid") |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sid, |
| @FormParam(value="appointment") |
| <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/calendar/AppointmentDTO.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.calendar">AppointmentDTO</a> appointment) |
| throws <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.error.ServiceException.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.error.ServiceException</a></pre> |
| <div class="block">Save an appointment</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sid</code> - The SID of the User. This SID must be marked as Loggedin</dd> |
| <dd><code>appointment</code> - calendar event</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>- appointment saved</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>{@link</code> - ServiceException} in case of any error</dd> |
| <dd><code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.error.ServiceException.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.error.ServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="delete-java.lang.String-java.lang.Long-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>delete</h4> |
| <pre>@DELETE |
| @Path(value="/{id}") |
| public <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.basic">ServiceResult</a> delete(@QueryParam(value="sid") |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sid, |
| @PathParam(value="id") |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> id) |
| throws <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.error.ServiceException.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.error.ServiceException</a></pre> |
| <div class="block">delete a calendar event |
| |
| If the given SID is from an Administrator or Web-Service user, the user |
| can delete any appointment.<br/> |
| If the SID is assigned to a simple user, he can only delete appointments |
| where he is also the owner/creator of the appointment</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sid</code> - an authenticated SID</dd> |
| <dd><code>id</code> - the id to delete</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html?is-external=true" title="class or interface in org.apache.openmeetings.db.dto.basic"><code>ServiceResult</code></a> of type SUCCESS</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>{@link</code> - ServiceException} in case of any error</dd> |
| <dd><code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/webservice.error.ServiceException.html?is-external=true" title="class or interface in org.apache.openmeetings">org.apache.openmeetings.webservice.error.ServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/CalendarWebService.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../org/apache/openmeetings/webservice/Constants.html" title="class in org.apache.openmeetings.webservice"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openmeetings/webservice/CalendarWebService.html" target="_top">Frames</a></li> |
| <li><a href="CalendarWebService.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2012–2017 <a href="http://apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |