001
014
015 package com.liferay.portal.kernel.lar;
016
017 import com.liferay.portal.kernel.exception.PortalException;
018 import com.liferay.portal.kernel.exception.SystemException;
019 import com.liferay.portal.kernel.util.KeyValuePair;
020 import com.liferay.portal.kernel.xml.Element;
021 import com.liferay.portal.kernel.zip.ZipReader;
022 import com.liferay.portal.kernel.zip.ZipWriter;
023 import com.liferay.portal.model.ClassedModel;
024 import com.liferay.portal.model.Lock;
025 import com.liferay.portal.service.ServiceContext;
026 import com.liferay.portlet.expando.model.ExpandoColumn;
027 import com.liferay.portlet.messageboards.model.MBMessage;
028 import com.liferay.portlet.ratings.model.RatingsEntry;
029
030 import java.io.InputStream;
031 import java.io.Serializable;
032
033 import java.util.Date;
034 import java.util.List;
035 import java.util.Map;
036 import java.util.Set;
037
038
047 public interface PortletDataContext extends Serializable {
048
049 public static final String ROOT_PATH_GROUPS = "/groups/";
050
051 public static final String ROOT_PATH_LAYOUTS = "/layouts/";
052
053 public static final String ROOT_PATH_PORTLETS = "/portlets/";
054
055 public void addAssetCategories(Class<?> clazz, long classPK)
056 throws SystemException;
057
058 public void addAssetCategories(
059 String className, long classPK, long[] assetCategoryIds);
060
061 public void addAssetTags(Class<?> clazz, long classPK)
062 throws SystemException;
063
064 public void addAssetTags(
065 String className, long classPK, String[] assetTagNames);
066
067 public void addClassedModel(
068 Element element, String path, ClassedModel classedModel,
069 String namespace)
070 throws PortalException, SystemException;
071
072 public void addComments(Class<?> clazz, long classPK)
073 throws SystemException;
074
075 public void addComments(
076 String className, long classPK, List<MBMessage> messages);
077
078 public void addLocks(Class<?> clazz, String key)
079 throws PortalException, SystemException;
080
081 public void addLocks(String className, String key, Lock lock);
082
083 public void addPermissions(Class<?> clazz, long classPK)
084 throws PortalException, SystemException;
085
086 public void addPermissions(String resourceName, long resourcePK)
087 throws PortalException, SystemException;
088
089 public void addPermissions(
090 String resourceName, long resourcePK, List<KeyValuePair> permissions);
091
092 public boolean addPrimaryKey(Class<?> clazz, String primaryKey);
093
094 public void addRatingsEntries(Class<?> clazz, long classPK)
095 throws SystemException;
096
097 public void addRatingsEntries(
098 String className, long classPK, List<RatingsEntry> ratingsEntries);
099
100 public void addZipEntry(String path, byte[] bytes) throws SystemException;
101
102 public void addZipEntry(String path, InputStream is) throws SystemException;
103
104 public void addZipEntry(String path, Object object) throws SystemException;
105
106 public void addZipEntry(String path, String s) throws SystemException;
107
108 public void addZipEntry(String name, StringBuilder sb)
109 throws SystemException;
110
111 public ServiceContext createServiceContext(
112 Element element, ClassedModel classedModel, String namespace);
113
114 public ServiceContext createServiceContext(
115 String path, ClassedModel classedModel, String namespace);
116
117 public Object fromXML(byte[] bytes);
118
119 public Object fromXML(String xml);
120
121 public long[] getAssetCategoryIds(Class<?> clazz, long classPK);
122
123 public Map<String, long[]> getAssetCategoryIdsMap();
124
125 public Map<String, String[]> getAssetCategoryUuidsMap();
126
127 public String[] getAssetTagNames(Class<?> clazz, long classPK);
128
129 public String[] getAssetTagNames(String className, long classPK);
130
131 public Map<String, String[]> getAssetTagNamesMap();
132
133 public boolean getBooleanParameter(String namespace, String name);
134
135 public ClassLoader getClassLoader();
136
137 public Map<String, List<MBMessage>> getComments();
138
139 public long getCompanyId();
140
141 public String getDataStrategy();
142
143 public Date getEndDate();
144
145 public Map<String, List<ExpandoColumn>> getExpandoColumns();
146
147 public long getGroupId();
148
149 public String getLayoutPath(long layoutId);
150
151 public Map<String, Lock> getLocks();
152
153 public Map<?, ?> getNewPrimaryKeysMap(Class<?> clazz);
154
155 public Map<?, ?> getNewPrimaryKeysMap(String className);
156
157 public long getOldPlid();
158
159 public Map<String, String[]> getParameterMap();
160
161 public Map<String, List<KeyValuePair>> getPermissions();
162
163 public long getPlid();
164
165 public String getPortletPath(String portletId);
166
167 public Set<String> getPrimaryKeys();
168
169 public Map<String, List<RatingsEntry>> getRatingsEntries();
170
171 public String getRootPath();
172
173 public long getScopeGroupId();
174
175 public String getScopeLayoutUuid();
176
177 public String getScopeType();
178
179 public long getSourceGroupId();
180
181 public String getSourceLayoutPath(long layoutId);
182
183 public String getSourcePortletPath(String portletId);
184
185 public String getSourceRootPath();
186
187 public Date getStartDate();
188
189 public long getUserId(String userUuid) throws SystemException;
190
191 public UserIdStrategy getUserIdStrategy() throws SystemException;
192
193 public List<String> getZipEntries();
194
195 public byte[] getZipEntryAsByteArray(String path);
196
197 public InputStream getZipEntryAsInputStream(String path);
198
199 public Object getZipEntryAsObject(String path);
200
201 public String getZipEntryAsString(String path);
202
203 public List<String> getZipFolderEntries();
204
205 public List<String> getZipFolderEntries(String path);
206
207 public ZipReader getZipReader();
208
209 public ZipWriter getZipWriter();
210
211 public boolean hasDateRange();
212
213 public boolean hasNotUniquePerLayout(String dataKey);
214
215 public boolean hasPrimaryKey(Class<?> clazz, String primaryKey);
216
217 public void importClassedModel(
218 ClassedModel classedModel, ClassedModel newClassedModel,
219 String namespace)
220 throws PortalException, SystemException;
221
222 public void importComments(
223 Class<?> clazz, long classPK, long newClassPK, long groupId)
224 throws PortalException, SystemException;
225
226 public void importLocks(Class<?> clazz, String key, String newKey)
227 throws PortalException, SystemException;
228
229 public void importPermissions(
230 Class<?> clazz, long classPK, long newClassPK)
231 throws PortalException, SystemException;
232
233 public void importPermissions(
234 String resourceObj, long resourcePK, long newResourcePK)
235 throws PortalException, SystemException;
236
237 public void importRatingsEntries(
238 Class<?> clazz, long classPK, long newClassPK)
239 throws PortalException, SystemException;
240
241 public boolean isDataStrategyMirror();
242
243 public boolean isDataStrategyMirrorWithOverwritting();
244
245 public boolean isPathNotProcessed(String path);
246
247 public boolean isPerformDirectBinaryImport();
248
249 public boolean isPrivateLayout();
250
251 public boolean isWithinDateRange(Date modifiedDate);
252
253 public void putNotUniquePerLayout(String dataKey);
254
255 public void setClassLoader(ClassLoader classLoader);
256
257 public void setGroupId(long groupId);
258
259 public void setOldPlid(long oldPlid);
260
261 public void setPlid(long plid);
262
263 public void setPortetDataContextListener(
264 PortletDataContextListener portletDataContextListener);
265
266 public void setPrivateLayout(boolean privateLayout);
267
268 public void setScopeGroupId(long scopeGroupId);
269
270 public void setScopeLayoutUuid(String scopeLayoutUuid);
271
272 public void setScopeType(String scopeType);
273
274 public void setSourceGroupId(long sourceGroupId);
275
276 public void setStartDate(Date startDate);
277
278 public String toXML(Object object);
279
280 }