1   /**
2    * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
3    *
4    * The contents of this file are subject to the terms of the Liferay Enterprise
5    * Subscription License ("License"). You may not use this file except in
6    * compliance with the License. You can obtain a copy of the License by
7    * contacting Liferay, Inc. See the License for the specific language governing
8    * permissions and limitations under the License, including but not limited to
9    * distribution rights of the Software.
10   *
11   *
12   * 
13   */
14  
15  package com.liferay.portal.lar;
16  
17  import com.liferay.portal.PortalException;
18  import com.liferay.portal.SystemException;
19  import com.liferay.portal.kernel.util.KeyValuePair;
20  import com.liferay.portal.kernel.zip.ZipReader;
21  import com.liferay.portal.kernel.zip.ZipWriter;
22  import com.liferay.portlet.messageboards.model.MBMessage;
23  import com.liferay.portlet.ratings.model.RatingsEntry;
24  
25  import java.io.InputStream;
26  import java.io.Serializable;
27  
28  import java.util.Date;
29  import java.util.List;
30  import java.util.Map;
31  import java.util.Set;
32  
33  /**
34   * <a href="PortletDataContext.java.html"><b><i>View Source</i></b></a>
35   *
36   * <p>
37   * Holds context information that is used during exporting and importing portlet
38   * data.
39   * </p>
40   *
41   * @author Brian Wing Shun Chan
42   * @author Raymond Augé
43   */
44  public interface PortletDataContext extends Serializable {
45  
46      public static final String ROOT_PATH_GROUPS = "/groups/";
47  
48      public static final String ROOT_PATH_LAYOUTS = "/layouts/";
49  
50      public static final String ROOT_PATH_PORTLETS = "/portlets/";
51  
52      public void addComments(Class<?> classObj, long classPK)
53          throws SystemException;
54  
55      public void addComments(
56          String className, long classPK, List<MBMessage> messages);
57  
58      public void addPermissions(Class<?> classObj, long classPK)
59          throws PortalException, SystemException;
60  
61      public void addPermissions(String resourceName, long resourcePK)
62          throws PortalException, SystemException;
63  
64      public void addPermissions(
65          String resourceName, long resourcePK, List<KeyValuePair> permissions);
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> ratingsEntries);
74  
75      public void addTagsCategories(Class<?> classObj, long classPK)
76          throws SystemException;
77  
78      public void addTagsCategories(
79          String className, long classPK, String[] tagsCategories);
80  
81      public void addTagsEntries(Class<?> classObj, long classPK)
82          throws SystemException;
83  
84      public void addTagsEntries(
85          String className, long classPK, String[] tagsEntries);
86  
87      public void addZipEntry(String path, byte[] bytes) throws SystemException;
88  
89      public void addZipEntry(String path, InputStream is) throws SystemException;
90  
91      public void addZipEntry(String path, Object object) throws SystemException;
92  
93      public void addZipEntry(String path, String s) throws SystemException;
94  
95      public void addZipEntry(String name, StringBuilder sb)
96          throws SystemException;
97  
98      public Object fromXML(byte[] bytes);
99  
100     public Object fromXML(String xml);
101 
102     public boolean getBooleanParameter(String namespace, String name);
103 
104     public ClassLoader getClassLoader();
105 
106     public Map<String, List<MBMessage>> getComments();
107 
108     public long getCompanyId();
109 
110     public String getDataStrategy();
111 
112     public Date getEndDate();
113 
114     public long getGroupId();
115 
116     public String getLayoutPath(long layoutId);
117 
118     public Map<?, ?> getNewPrimaryKeysMap(Class<?> classObj);
119 
120     public long getOldPlid();
121 
122     public Map<String, String[]> getParameterMap();
123 
124     public Map<String, List<KeyValuePair>> getPermissions();
125 
126     public long getPlid();
127 
128     public String getPortletPath(String portletId);
129 
130     public Set<String> getPrimaryKeys();
131 
132     public Map<String, List<RatingsEntry>> getRatingsEntries();
133 
134     public String getRootPath();
135 
136     public long getScopeGroupId();
137 
138     public long getScopeLayoutId();
139 
140     public long getSourceGroupId();
141 
142     public String getSourceLayoutPath(long layoutId);
143 
144     public String getSourcePortletPath(String portletId);
145 
146     public String getSourceRootPath();
147 
148     public Date getStartDate();
149 
150     public Map<String, String[]> getTagsCategories();
151 
152     public String[] getTagsCategories(Class<?> classObj, long classPK);
153 
154     public Map<String, String[]> getTagsEntries();
155 
156     public String[] getTagsEntries(Class<?> classObj, long classPK);
157 
158     public String[] getTagsEntries(String className, long classPK);
159 
160     public long getUserId(String userUuid) throws SystemException;
161 
162     public UserIdStrategy getUserIdStrategy() throws SystemException;
163 
164     public List<String> getZipEntries();
165 
166     public byte[] getZipEntryAsByteArray(String path);
167 
168     public InputStream getZipEntryAsInputStream(String path);
169 
170     public Object getZipEntryAsObject(String path);
171 
172     public String getZipEntryAsString(String path);
173 
174     public List<String> getZipFolderEntries();
175 
176     public List<String> getZipFolderEntries(String path);
177 
178     public ZipReader getZipReader();
179 
180     public ZipWriter getZipWriter();
181 
182     public boolean hasDateRange();
183 
184     public boolean hasNotUniquePerLayout(String dataKey);
185 
186     public boolean hasPrimaryKey(Class<?> classObj, String primaryKey);
187 
188     public void importComments(
189             Class<?> classObj, long classPK, long newClassPK, long groupId)
190         throws PortalException, SystemException;
191 
192     public void importPermissions(
193             Class<?> classObj, long classPK, long newClassPK)
194         throws PortalException, SystemException;
195 
196     public void importPermissions(
197             String resourceObj, long resourcePK, long newResourcePK)
198         throws PortalException, SystemException;
199 
200     public void importRatingsEntries(
201             Class<?> classObj, long classPK, long newClassPK)
202         throws PortalException, SystemException;
203 
204     public boolean isPathNotProcessed(String path);
205 
206     public boolean isPrivateLayout();
207 
208     public boolean isWithinDateRange(Date modifiedDate);
209 
210     public void putNotUniquePerLayout(String dataKey);
211 
212     public void setClassLoader(ClassLoader classLoader);
213 
214     public void setGroupId(long groupId);
215 
216     public void setOldPlid(long oldPlid);
217 
218     public void setPlid(long plid);
219 
220     public void setPrivateLayout(boolean privateLayout);
221 
222     public void setScopeGroupId(long scopeGroupId);
223 
224     public void setScopeLayoutId(long scopeLayoutId);
225 
226     public void setSourceGroupId(long sourceGroupId);
227 
228     public String toXML(Object object);
229 
230 }