1 /* 2 * $Header: /home/cvs/jakarta-slide/src/share/org/apache/slide/event/RemoteInformation.java,v 1.3 2004/07/28 09:36:22 ib Exp $ 3 * $Revision: 1.3 $ 4 * $Date: 2004/07/28 09:36:22 $ 5 * 6 * ==================================================================== 7 * 8 * Copyright 1999-2002 The Apache Software Foundation 9 * 10 * Licensed under the Apache License, Version 2.0 (the "License"); 11 * you may not use this file except in compliance with the License. 12 * You may obtain a copy of the License at 13 * 14 * http://www.apache.org/licenses/LICENSE-2.0 15 * 16 * Unless required by applicable law or agreed to in writing, software 17 * distributed under the License is distributed on an "AS IS" BASIS, 18 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 19 * See the License for the specific language governing permissions and 20 * limitations under the License. 21 * 22 */ 23 24 package org.apache.slide.event; 25 26 /** 27 * <p>The RemoteInformation interface.<p> 28 * <p> 29 * This is currently used by the webdav {@link org.apache.slide.webdav.method.PollMethod PollMethod} 30 * to generate an XML representation of the data in an {@link org.apache.slide.event event}. 31 * </p> 32 * 33 */ 34 public interface RemoteInformation { 35 36 /** 37 * The returned String[][] is assumed to be a String[?][2], where ? is 38 * greater than or equal to 0. The format of the returned value is 39 * assumed to be: 40 * <pre> 41 * { 42 * { "XML Element Name 1", "XML Element Value 1"}, 43 * { "XML Element Name 2", "XML Element Value 2"}, 44 * etc... 45 * } 46 * </pre> 47 * One noteable value for the element name is "uri". The Slide context path 48 * is preppended to the value of an element with this name before it is 49 * returned to the client. 50 * 51 * @return an array of name = value pairs. 52 */ 53 public String[][] getInformation(); 54 } 55