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.SimpleIQ;
023import org.jivesoftware.smack.packet.XmlEnvironment;
024import org.jivesoftware.smack.parsing.SmackParsingException;
025import org.jivesoftware.smack.provider.IQProvider;
026import org.jivesoftware.smack.util.PacketParserUtils;
027import org.jivesoftware.smack.xml.XmlPullParser;
028import org.jivesoftware.smack.xml.XmlPullParserException;
029
030/**
031 * IQ stanza for retrieving the transcript search form, submitting the completed search form
032 * or retrieving the answer of a transcript search.
033 *
034 * @author Gaston Dombiak
035 */
036public class TranscriptSearch extends SimpleIQ {
037
038    /**
039    * Element name of the stanza extension.
040    */
041   public static final String ELEMENT_NAME = "transcript-search";
042
043   /**
044    * Namespace of the stanza extension.
045    */
046   public static final String NAMESPACE = "http://jivesoftware.com/protocol/workgroup";
047
048   public TranscriptSearch() {
049       super(ELEMENT_NAME, NAMESPACE);
050   }
051
052    /**
053     * An IQProvider for TranscriptSearch packets.
054     *
055     * @author Gaston Dombiak
056     */
057    public static class Provider extends IQProvider<TranscriptSearch> {
058
059        @Override
060        public TranscriptSearch parse(XmlPullParser parser, int initialDepth, XmlEnvironment xmlEnvironment) throws XmlPullParserException, IOException, SmackParsingException {
061            TranscriptSearch answer = new TranscriptSearch();
062
063            boolean done = false;
064            while (!done) {
065                XmlPullParser.Event eventType = parser.next();
066                if (eventType == XmlPullParser.Event.START_ELEMENT) {
067                    // Parse the packet extension
068                    PacketParserUtils.addExtensionElement(answer, parser, xmlEnvironment);
069                }
070                else if (eventType == XmlPullParser.Event.END_ELEMENT) {
071                    if (parser.getName().equals(ELEMENT_NAME)) {
072                        done = true;
073                    }
074                }
075            }
076
077            return answer;
078        }
079    }
080}