001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
013     */
014    
015    package com.liferay.portal.kernel.poller;
016    
017    import com.liferay.portal.kernel.json.JSONArray;
018    import com.liferay.portal.kernel.json.JSONObject;
019    import com.liferay.portal.kernel.messaging.Message;
020    
021    /**
022     * @author Brian Wing Shun Chan
023     * @author Edward Han
024     */
025    public interface PollerResponse {
026    
027            public static final String POLLER_HINT_HIGH_CONNECTIVITY =
028                    "pollerHintHighConnectivity";
029    
030            public void close();
031    
032            public void createResponseMessage(Message message);
033    
034            public PollerHeader getPollerHeader();
035    
036            public String getPortletId();
037    
038            public boolean isEmpty();
039    
040            public void setParameter(String name, JSONArray value)
041                    throws PollerResponseClosedException;
042    
043            public void setParameter(String name, JSONObject value)
044                    throws PollerResponseClosedException;
045    
046            public void setParameter(String name, String value)
047                    throws PollerResponseClosedException;
048    
049            public JSONObject toJSONObject();
050    
051    }