001/**
002 *
003 * Copyright 2003-2007 Jive Software.
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.jivesoftware.smackx.workgroup.packet;
019
020import java.io.IOException;
021
022import org.jivesoftware.smack.packet.IqData;
023import org.jivesoftware.smack.packet.SimpleIQ;
024import org.jivesoftware.smack.packet.XmlEnvironment;
025import org.jivesoftware.smack.parsing.SmackParsingException;
026import org.jivesoftware.smack.provider.IqProvider;
027import org.jivesoftware.smack.util.PacketParserUtils;
028import org.jivesoftware.smack.xml.XmlPullParser;
029import org.jivesoftware.smack.xml.XmlPullParserException;
030
031/**
032 * IQ stanza for retrieving the transcript search form, submitting the completed search form
033 * or retrieving the answer of a transcript search.
034 *
035 * @author Gaston Dombiak
036 */
037public class TranscriptSearch extends SimpleIQ {
038
039    /**
040    * Element name of the stanza extension.
041    */
042   public static final String ELEMENT_NAME = "transcript-search";
043
044   /**
045    * Namespace of the stanza extension.
046    */
047   public static final String NAMESPACE = "http://jivesoftware.com/protocol/workgroup";
048
049   public TranscriptSearch() {
050       super(ELEMENT_NAME, NAMESPACE);
051   }
052
053    /**
054     * An IQProvider for TranscriptSearch packets.
055     *
056     * @author Gaston Dombiak
057     */
058    public static class Provider extends IqProvider<TranscriptSearch> {
059
060        @Override
061        public TranscriptSearch parse(XmlPullParser parser, int initialDepth, IqData iqData, XmlEnvironment xmlEnvironment) throws XmlPullParserException, IOException, SmackParsingException {
062            TranscriptSearch answer = new TranscriptSearch();
063
064            boolean done = false;
065            while (!done) {
066                XmlPullParser.Event eventType = parser.next();
067                if (eventType == XmlPullParser.Event.START_ELEMENT) {
068                    // Parse the packet extension
069                    PacketParserUtils.addExtensionElement(answer, parser, xmlEnvironment);
070                }
071                else if (eventType == XmlPullParser.Event.END_ELEMENT) {
072                    if (parser.getName().equals(ELEMENT_NAME)) {
073                        done = true;
074                    }
075                }
076            }
077
078            return answer;
079        }
080    }
081}