blob: 8d36125a2cbe5b69b874caf16812b062f8452e24 [file] [log] [blame]
<!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_121) on Wed Feb 08 21:19:12 NOVT 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CtagHandler (Openmeetings Service 3.2.0 API)</title>
<meta name="date" content="2017-02-08">
<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="CtagHandler (Openmeetings Service 3.2.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":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/CtagHandler.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><a href="../../../../../../../org/apache/openmeetings/service/calendar/caldav/handler/CalendarHandler.html" title="interface in org.apache.openmeetings.service.calendar.caldav.handler"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/openmeetings/service/calendar/caldav/handler/EtagsHandler.html" title="class in org.apache.openmeetings.service.calendar.caldav.handler"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/openmeetings/service/calendar/caldav/handler/CtagHandler.html" target="_top">Frames</a></li>
<li><a href="CtagHandler.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.service.calendar.caldav.handler</div>
<h2 title="Class CtagHandler" class="title">Class CtagHandler</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><a href="../../../../../../../org/apache/openmeetings/service/calendar/caldav/handler/AbstractCalendarHandler.html" title="class in org.apache.openmeetings.service.calendar.caldav.handler">org.apache.openmeetings.service.calendar.caldav.handler.AbstractCalendarHandler</a></li>
<li>
<ul class="inheritance">
<li>org.apache.openmeetings.service.calendar.caldav.handler.CtagHandler</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../../org/apache/openmeetings/service/calendar/caldav/handler/CalendarHandler.html" title="interface in org.apache.openmeetings.service.calendar.caldav.handler">CalendarHandler</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">CtagHandler</span>
extends <a href="../../../../../../../org/apache/openmeetings/service/calendar/caldav/handler/AbstractCalendarHandler.html" title="class in org.apache.openmeetings.service.calendar.caldav.handler">AbstractCalendarHandler</a></pre>
<div class="block">Class for Syncing through the help of Ctags.
It checks if the Ctag of the Calendar has changed.
If it has then update the events, otherwise leave it as it is.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../org/apache/openmeetings/service/calendar/caldav/handler/CalendarHandler.html" title="interface in org.apache.openmeetings.service.calendar.caldav.handler"><code>CalendarHandler</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static org.apache.jackrabbit.webdav.property.DavPropertyName</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/openmeetings/service/calendar/caldav/handler/CtagHandler.html#DNAME_GETCTAG">DNAME_GETCTAG</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static org.apache.jackrabbit.webdav.xml.Namespace</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/openmeetings/service/calendar/caldav/handler/CtagHandler.html#NAMESPACE_CALSERVER">NAMESPACE_CALSERVER</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.openmeetings.service.calendar.caldav.handler.AbstractCalendarHandler">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.openmeetings.service.calendar.caldav.handler.<a href="../../../../../../../org/apache/openmeetings/service/calendar/caldav/handler/AbstractCalendarHandler.html" title="class in org.apache.openmeetings.service.calendar.caldav.handler">AbstractCalendarHandler</a></h3>
<code><a href="../../../../../../../org/apache/openmeetings/service/calendar/caldav/handler/AbstractCalendarHandler.html#appointmentDao">appointmentDao</a>, <a href="../../../../../../../org/apache/openmeetings/service/calendar/caldav/handler/AbstractCalendarHandler.html#calendar">calendar</a>, <a href="../../../../../../../org/apache/openmeetings/service/calendar/caldav/handler/AbstractCalendarHandler.html#client">client</a>, <a href="../../../../../../../org/apache/openmeetings/service/calendar/caldav/handler/AbstractCalendarHandler.html#path">path</a>, <a href="../../../../../../../org/apache/openmeetings/service/calendar/caldav/handler/AbstractCalendarHandler.html#utils">utils</a></code></li>
</ul>
</li>
</ul>
<!-- ======== 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">&nbsp;</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/service/calendar/caldav/handler/CtagHandler.html#CtagHandler-java.lang.String-org.apache.openmeetings.db.entity.calendar.OmCalendar-org.apache.commons.httpclient.HttpClient-org.apache.openmeetings.db.dao.calendar.AppointmentDao-org.apache.openmeetings.service.calendar.caldav.iCalUtils-">CtagHandler</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>&nbsp;path,
org.apache.openmeetings.db.entity.calendar.OmCalendar&nbsp;calendar,
org.apache.commons.httpclient.HttpClient&nbsp;client,
org.apache.openmeetings.db.dao.calendar.AppointmentDao&nbsp;appointmentDao,
<a href="../../../../../../../org/apache/openmeetings/service/calendar/caldav/iCalUtils.html" title="class in org.apache.openmeetings.service.calendar.caldav">iCalUtils</a>&nbsp;utils)</code>&nbsp;</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/openmeetings/service/calendar/caldav/handler/CtagHandler.html#deleteItem-org.apache.openmeetings.db.entity.calendar.Appointment-">deleteItem</a></span>(org.apache.openmeetings.db.entity.calendar.Appointment&nbsp;appointment)</code>
<div class="block">Delete Appointment on the server.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>org.apache.openmeetings.db.entity.calendar.OmCalendar</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/openmeetings/service/calendar/caldav/handler/CtagHandler.html#syncItems--">syncItems</a></span>()</code>
<div class="block">Function to update all items in the CalDAV calendar.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/openmeetings/service/calendar/caldav/handler/CtagHandler.html#updateItem-org.apache.openmeetings.db.entity.calendar.Appointment-">updateItem</a></span>(org.apache.openmeetings.db.entity.calendar.Appointment&nbsp;appointment)</code>
<div class="block">Function for create/updating multiple appointment on the server.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.openmeetings.service.calendar.caldav.handler.AbstractCalendarHandler">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.openmeetings.service.calendar.caldav.handler.<a href="../../../../../../../org/apache/openmeetings/service/calendar/caldav/handler/AbstractCalendarHandler.html" title="class in org.apache.openmeetings.service.calendar.caldav.handler">AbstractCalendarHandler</a></h3>
<code><a href="../../../../../../../org/apache/openmeetings/service/calendar/caldav/handler/AbstractCalendarHandler.html#listToMap-java.util.List-java.util.List-">listToMap</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="NAMESPACE_CALSERVER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NAMESPACE_CALSERVER</h4>
<pre>public static final&nbsp;org.apache.jackrabbit.webdav.xml.Namespace NAMESPACE_CALSERVER</pre>
</li>
</ul>
<a name="DNAME_GETCTAG">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DNAME_GETCTAG</h4>
<pre>public static final&nbsp;org.apache.jackrabbit.webdav.property.DavPropertyName DNAME_GETCTAG</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CtagHandler-java.lang.String-org.apache.openmeetings.db.entity.calendar.OmCalendar-org.apache.commons.httpclient.HttpClient-org.apache.openmeetings.db.dao.calendar.AppointmentDao-org.apache.openmeetings.service.calendar.caldav.iCalUtils-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CtagHandler</h4>
<pre>public&nbsp;CtagHandler(<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>&nbsp;path,
org.apache.openmeetings.db.entity.calendar.OmCalendar&nbsp;calendar,
org.apache.commons.httpclient.HttpClient&nbsp;client,
org.apache.openmeetings.db.dao.calendar.AppointmentDao&nbsp;appointmentDao,
<a href="../../../../../../../org/apache/openmeetings/service/calendar/caldav/iCalUtils.html" title="class in org.apache.openmeetings.service.calendar.caldav">iCalUtils</a>&nbsp;utils)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="syncItems--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>syncItems</h4>
<pre>public&nbsp;org.apache.openmeetings.db.entity.calendar.OmCalendar&nbsp;syncItems()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/openmeetings/service/calendar/caldav/handler/CalendarHandler.html#syncItems--">CalendarHandler</a></code></span></div>
<div class="block">Function to update all items in the CalDAV calendar. The owner of the appointments
created are the same as the owner of the calendar.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Returns the updated calendar after updation of all events.</dd>
</dl>
</li>
</ul>
<a name="updateItem-org.apache.openmeetings.db.entity.calendar.Appointment-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateItem</h4>
<pre>public&nbsp;boolean&nbsp;updateItem(org.apache.openmeetings.db.entity.calendar.Appointment&nbsp;appointment)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/openmeetings/service/calendar/caldav/handler/CalendarHandler.html#updateItem-org.apache.openmeetings.db.entity.calendar.Appointment-">CalendarHandler</a></code></span></div>
<div class="block">Function for create/updating multiple appointment on the server.
Performs modification alongside of creation new events on the server.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>appointment</code> - Appointment to create/update.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>True</code> when the updation is a success else <code>False</code></dd>
</dl>
</li>
</ul>
<a name="deleteItem-org.apache.openmeetings.db.entity.calendar.Appointment-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>deleteItem</h4>
<pre>public&nbsp;boolean&nbsp;deleteItem(org.apache.openmeetings.db.entity.calendar.Appointment&nbsp;appointment)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/openmeetings/service/calendar/caldav/handler/CalendarHandler.html#deleteItem-org.apache.openmeetings.db.entity.calendar.Appointment-">CalendarHandler</a></code></span></div>
<div class="block">Delete Appointment on the server.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>appointment</code> - Appointment to delete</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>True</code> when the deletion is a success else <code>False</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/CtagHandler.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><a href="../../../../../../../org/apache/openmeetings/service/calendar/caldav/handler/CalendarHandler.html" title="interface in org.apache.openmeetings.service.calendar.caldav.handler"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/openmeetings/service/calendar/caldav/handler/EtagsHandler.html" title="class in org.apache.openmeetings.service.calendar.caldav.handler"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/openmeetings/service/calendar/caldav/handler/CtagHandler.html" target="_top">Frames</a></li>
<li><a href="CtagHandler.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2012&#x2013;2017 <a href="http://apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>