1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.lar;
24  
25  import com.liferay.portal.PortalException;
26  import com.liferay.portal.SystemException;
27  import com.liferay.portal.kernel.util.ObjectValuePair;
28  import com.liferay.portal.kernel.zip.ZipReader;
29  import com.liferay.portal.kernel.zip.ZipWriter;
30  import com.liferay.portlet.messageboards.model.MBMessage;
31  import com.liferay.portlet.ratings.model.RatingsEntry;
32  
33  import java.io.InputStream;
34  import java.io.Serializable;
35  
36  import java.util.Date;
37  import java.util.List;
38  import java.util.Map;
39  import java.util.Set;
40  
41  /**
42   * <a href="PortletDataContext.java.html"><b><i>View Source</i></b></a>
43   *
44   * <p>
45   * Holds context information that is used during exporting and importing portlet
46   * data.
47   * </p>
48   *
49   * @author Brian Wing Shun Chan
50   * @author Raymond Augé
51   *
52   */
53  public interface PortletDataContext extends Serializable {
54  
55      public static final String ROOT_PATH_GROUPS = "/groups/";
56  
57      public static final String ROOT_PATH_LAYOUTS = "/layouts/";
58  
59      public static final String ROOT_PATH_PORTLETS = "/portlets/";
60  
61      public void addComments(Class<?> classObj, long classPK)
62          throws SystemException;
63  
64      public void addComments(
65          String className, long classPK, List<MBMessage> messages);
66  
67      public boolean addPrimaryKey(Class<?> classObj, String primaryKey);
68  
69      public void addRatingsEntries(Class<?> classObj, long classPK)
70          throws SystemException;
71  
72      public void addRatingsEntries(
73          String className, long classPK, List<RatingsEntry> entries);
74  
75      public void addTagsEntries(Class<?> classObj, long classPK)
76          throws PortalException, SystemException;
77  
78      public void addTagsEntries(String className, long classPK, String[] values);
79  
80      public void addZipEntry(String path, byte[] bytes) throws SystemException;
81  
82      public void addZipEntry(String path, InputStream is) throws SystemException;
83  
84      public void addZipEntry(String path, Object object) throws SystemException;
85  
86      public void addZipEntry(String path, String s) throws SystemException;
87  
88      public void addZipEntry(String name, StringBuilder sb)
89          throws SystemException;
90  
91      public Object fromXML(byte[] bytes);
92  
93      public Object fromXML(String xml);
94  
95      public boolean getBooleanParameter(String namespace, String name);
96  
97      public ClassLoader getClassLoader();
98  
99      public Map<String, List<MBMessage>> getComments();
100 
101     public long getCompanyId();
102 
103     public String getDataStrategy();
104 
105     public Date getEndDate();
106 
107     public long getGroupId();
108 
109     public long getImportGroupId();
110 
111     public String getImportLayoutPath(long layoutId);
112 
113     public String getImportPortletPath(String portletId);
114 
115     public String getImportRootPath();
116 
117     public String getLayoutPath(long layoutId);
118 
119     public Map<?, ?> getNewPrimaryKeysMap(Class<?> classObj);
120 
121     public long getOldPlid();
122 
123     public Map<String, String[]> getParameterMap();
124 
125     public long getPlid();
126 
127     public String getPortletPath(String portletId);
128 
129     public Set<String> getPrimaryKeys();
130 
131     public Map<String, List<RatingsEntry>> getRatingsEntries();
132 
133     public String getRootPath();
134 
135     public Date getStartDate();
136 
137     public Map<String, String[]> getTagsEntries();
138 
139     public String[] getTagsEntries(Class<?> classObj, long classPK);
140 
141     public String[] getTagsEntries(String className, long classPK);
142 
143     public long getUserId(String userUuid) throws SystemException;
144 
145     public UserIdStrategy getUserIdStrategy() throws SystemException;
146 
147     public Map<String, byte[]> getZipEntries();
148 
149     public byte[] getZipEntryAsByteArray(String path);
150 
151     public Object getZipEntryAsObject(String path);
152 
153     public String getZipEntryAsString(String path);
154 
155     public Map<String, List<ObjectValuePair<String, byte[]>>>
156         getZipFolderEntries();
157 
158     public List<ObjectValuePair<String, byte[]>> getZipFolderEntries(
159         String path);
160 
161     public ZipReader getZipReader();
162 
163     public ZipWriter getZipWriter();
164 
165     public boolean hasDateRange();
166 
167     public boolean hasNotUniquePerLayout(String portletId);
168 
169     public boolean hasPrimaryKey(Class<?> classObj, String primaryKey);
170 
171     public void importComments(
172             Class<?> classObj, long classPK, long newClassPK, long groupId)
173         throws PortalException, SystemException;
174 
175     public void importRatingsEntries(
176             Class<?> classObj, long classPK, long newClassPK)
177         throws PortalException, SystemException;
178 
179     public boolean isPathNotProcessed(String path);
180 
181     public boolean isWithinDateRange(Date modifiedDate);
182 
183     public void putNotUniquePerLayout(String portletId);
184 
185     public void setClassLoader(ClassLoader classLoader);
186 
187     public void setImportGroupId(long importGroupId);
188 
189     public void setOldPlid(long oldPlid);
190 
191     public void setPlid(long plid);
192 
193     public String toXML(Object object);
194 
195 }