/portal-service/src/com/liferay/portlet/documentlibrary/model/DLFileVersionModel.java

https://github.com/abdlquadri/liferay-portal · Java · 476 lines · 93 code · 77 blank · 306 comment · 0 complexity · 93996fc55aea8686ae5d18cd9e3f28eb MD5 · raw file

  1. /**
  2. * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
  3. *
  4. * This library is free software; you can redistribute it and/or modify it under
  5. * the terms of the GNU Lesser General Public License as published by the Free
  6. * Software Foundation; either version 2.1 of the License, or (at your option)
  7. * any later version.
  8. *
  9. * This library is distributed in the hope that it will be useful, but WITHOUT
  10. * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  11. * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
  12. * details.
  13. */
  14. package com.liferay.portlet.documentlibrary.model;
  15. import com.liferay.portal.kernel.bean.AutoEscape;
  16. import com.liferay.portal.kernel.exception.SystemException;
  17. import com.liferay.portal.model.BaseModel;
  18. import com.liferay.portal.model.CacheModel;
  19. import com.liferay.portal.model.WorkflowedModel;
  20. import com.liferay.portal.service.ServiceContext;
  21. import com.liferay.portlet.expando.model.ExpandoBridge;
  22. import java.io.Serializable;
  23. import java.util.Date;
  24. /**
  25. * The base model interface for the DLFileVersion service. Represents a row in the "DLFileVersion" database table, with each column mapped to a property of this class.
  26. *
  27. * <p>
  28. * This interface and its corresponding implementation {@link com.liferay.portlet.documentlibrary.model.impl.DLFileVersionModelImpl} exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in {@link com.liferay.portlet.documentlibrary.model.impl.DLFileVersionImpl}.
  29. * </p>
  30. *
  31. * @author Brian Wing Shun Chan
  32. * @see DLFileVersion
  33. * @see com.liferay.portlet.documentlibrary.model.impl.DLFileVersionImpl
  34. * @see com.liferay.portlet.documentlibrary.model.impl.DLFileVersionModelImpl
  35. * @generated
  36. */
  37. public interface DLFileVersionModel extends BaseModel<DLFileVersion>,
  38. WorkflowedModel {
  39. /*
  40. * NOTE FOR DEVELOPERS:
  41. *
  42. * Never modify or reference this interface directly. All methods that expect a document library file version model instance should use the {@link DLFileVersion} interface instead.
  43. */
  44. /**
  45. * Returns the primary key of this document library file version.
  46. *
  47. * @return the primary key of this document library file version
  48. */
  49. public long getPrimaryKey();
  50. /**
  51. * Sets the primary key of this document library file version.
  52. *
  53. * @param primaryKey the primary key of this document library file version
  54. */
  55. public void setPrimaryKey(long primaryKey);
  56. /**
  57. * Returns the file version ID of this document library file version.
  58. *
  59. * @return the file version ID of this document library file version
  60. */
  61. public long getFileVersionId();
  62. /**
  63. * Sets the file version ID of this document library file version.
  64. *
  65. * @param fileVersionId the file version ID of this document library file version
  66. */
  67. public void setFileVersionId(long fileVersionId);
  68. /**
  69. * Returns the group ID of this document library file version.
  70. *
  71. * @return the group ID of this document library file version
  72. */
  73. public long getGroupId();
  74. /**
  75. * Sets the group ID of this document library file version.
  76. *
  77. * @param groupId the group ID of this document library file version
  78. */
  79. public void setGroupId(long groupId);
  80. /**
  81. * Returns the company ID of this document library file version.
  82. *
  83. * @return the company ID of this document library file version
  84. */
  85. public long getCompanyId();
  86. /**
  87. * Sets the company ID of this document library file version.
  88. *
  89. * @param companyId the company ID of this document library file version
  90. */
  91. public void setCompanyId(long companyId);
  92. /**
  93. * Returns the user ID of this document library file version.
  94. *
  95. * @return the user ID of this document library file version
  96. */
  97. public long getUserId();
  98. /**
  99. * Sets the user ID of this document library file version.
  100. *
  101. * @param userId the user ID of this document library file version
  102. */
  103. public void setUserId(long userId);
  104. /**
  105. * Returns the user uuid of this document library file version.
  106. *
  107. * @return the user uuid of this document library file version
  108. * @throws SystemException if a system exception occurred
  109. */
  110. public String getUserUuid() throws SystemException;
  111. /**
  112. * Sets the user uuid of this document library file version.
  113. *
  114. * @param userUuid the user uuid of this document library file version
  115. */
  116. public void setUserUuid(String userUuid);
  117. /**
  118. * Returns the user name of this document library file version.
  119. *
  120. * @return the user name of this document library file version
  121. */
  122. @AutoEscape
  123. public String getUserName();
  124. /**
  125. * Sets the user name of this document library file version.
  126. *
  127. * @param userName the user name of this document library file version
  128. */
  129. public void setUserName(String userName);
  130. /**
  131. * Returns the create date of this document library file version.
  132. *
  133. * @return the create date of this document library file version
  134. */
  135. public Date getCreateDate();
  136. /**
  137. * Sets the create date of this document library file version.
  138. *
  139. * @param createDate the create date of this document library file version
  140. */
  141. public void setCreateDate(Date createDate);
  142. /**
  143. * Returns the repository ID of this document library file version.
  144. *
  145. * @return the repository ID of this document library file version
  146. */
  147. public long getRepositoryId();
  148. /**
  149. * Sets the repository ID of this document library file version.
  150. *
  151. * @param repositoryId the repository ID of this document library file version
  152. */
  153. public void setRepositoryId(long repositoryId);
  154. /**
  155. * Returns the folder ID of this document library file version.
  156. *
  157. * @return the folder ID of this document library file version
  158. */
  159. public long getFolderId();
  160. /**
  161. * Sets the folder ID of this document library file version.
  162. *
  163. * @param folderId the folder ID of this document library file version
  164. */
  165. public void setFolderId(long folderId);
  166. /**
  167. * Returns the file entry ID of this document library file version.
  168. *
  169. * @return the file entry ID of this document library file version
  170. */
  171. public long getFileEntryId();
  172. /**
  173. * Sets the file entry ID of this document library file version.
  174. *
  175. * @param fileEntryId the file entry ID of this document library file version
  176. */
  177. public void setFileEntryId(long fileEntryId);
  178. /**
  179. * Returns the extension of this document library file version.
  180. *
  181. * @return the extension of this document library file version
  182. */
  183. @AutoEscape
  184. public String getExtension();
  185. /**
  186. * Sets the extension of this document library file version.
  187. *
  188. * @param extension the extension of this document library file version
  189. */
  190. public void setExtension(String extension);
  191. /**
  192. * Returns the mime type of this document library file version.
  193. *
  194. * @return the mime type of this document library file version
  195. */
  196. @AutoEscape
  197. public String getMimeType();
  198. /**
  199. * Sets the mime type of this document library file version.
  200. *
  201. * @param mimeType the mime type of this document library file version
  202. */
  203. public void setMimeType(String mimeType);
  204. /**
  205. * Returns the title of this document library file version.
  206. *
  207. * @return the title of this document library file version
  208. */
  209. @AutoEscape
  210. public String getTitle();
  211. /**
  212. * Sets the title of this document library file version.
  213. *
  214. * @param title the title of this document library file version
  215. */
  216. public void setTitle(String title);
  217. /**
  218. * Returns the description of this document library file version.
  219. *
  220. * @return the description of this document library file version
  221. */
  222. @AutoEscape
  223. public String getDescription();
  224. /**
  225. * Sets the description of this document library file version.
  226. *
  227. * @param description the description of this document library file version
  228. */
  229. public void setDescription(String description);
  230. /**
  231. * Returns the change log of this document library file version.
  232. *
  233. * @return the change log of this document library file version
  234. */
  235. @AutoEscape
  236. public String getChangeLog();
  237. /**
  238. * Sets the change log of this document library file version.
  239. *
  240. * @param changeLog the change log of this document library file version
  241. */
  242. public void setChangeLog(String changeLog);
  243. /**
  244. * Returns the extra settings of this document library file version.
  245. *
  246. * @return the extra settings of this document library file version
  247. */
  248. @AutoEscape
  249. public String getExtraSettings();
  250. /**
  251. * Sets the extra settings of this document library file version.
  252. *
  253. * @param extraSettings the extra settings of this document library file version
  254. */
  255. public void setExtraSettings(String extraSettings);
  256. /**
  257. * Returns the file entry type ID of this document library file version.
  258. *
  259. * @return the file entry type ID of this document library file version
  260. */
  261. public long getFileEntryTypeId();
  262. /**
  263. * Sets the file entry type ID of this document library file version.
  264. *
  265. * @param fileEntryTypeId the file entry type ID of this document library file version
  266. */
  267. public void setFileEntryTypeId(long fileEntryTypeId);
  268. /**
  269. * Returns the version of this document library file version.
  270. *
  271. * @return the version of this document library file version
  272. */
  273. @AutoEscape
  274. public String getVersion();
  275. /**
  276. * Sets the version of this document library file version.
  277. *
  278. * @param version the version of this document library file version
  279. */
  280. public void setVersion(String version);
  281. /**
  282. * Returns the size of this document library file version.
  283. *
  284. * @return the size of this document library file version
  285. */
  286. public long getSize();
  287. /**
  288. * Sets the size of this document library file version.
  289. *
  290. * @param size the size of this document library file version
  291. */
  292. public void setSize(long size);
  293. /**
  294. * Returns the status of this document library file version.
  295. *
  296. * @return the status of this document library file version
  297. */
  298. public int getStatus();
  299. /**
  300. * Sets the status of this document library file version.
  301. *
  302. * @param status the status of this document library file version
  303. */
  304. public void setStatus(int status);
  305. /**
  306. * Returns the status by user ID of this document library file version.
  307. *
  308. * @return the status by user ID of this document library file version
  309. */
  310. public long getStatusByUserId();
  311. /**
  312. * Sets the status by user ID of this document library file version.
  313. *
  314. * @param statusByUserId the status by user ID of this document library file version
  315. */
  316. public void setStatusByUserId(long statusByUserId);
  317. /**
  318. * Returns the status by user uuid of this document library file version.
  319. *
  320. * @return the status by user uuid of this document library file version
  321. * @throws SystemException if a system exception occurred
  322. */
  323. public String getStatusByUserUuid() throws SystemException;
  324. /**
  325. * Sets the status by user uuid of this document library file version.
  326. *
  327. * @param statusByUserUuid the status by user uuid of this document library file version
  328. */
  329. public void setStatusByUserUuid(String statusByUserUuid);
  330. /**
  331. * Returns the status by user name of this document library file version.
  332. *
  333. * @return the status by user name of this document library file version
  334. */
  335. @AutoEscape
  336. public String getStatusByUserName();
  337. /**
  338. * Sets the status by user name of this document library file version.
  339. *
  340. * @param statusByUserName the status by user name of this document library file version
  341. */
  342. public void setStatusByUserName(String statusByUserName);
  343. /**
  344. * Returns the status date of this document library file version.
  345. *
  346. * @return the status date of this document library file version
  347. */
  348. public Date getStatusDate();
  349. /**
  350. * Sets the status date of this document library file version.
  351. *
  352. * @param statusDate the status date of this document library file version
  353. */
  354. public void setStatusDate(Date statusDate);
  355. /**
  356. * @deprecated Renamed to {@link #isApproved()}
  357. */
  358. public boolean getApproved();
  359. /**
  360. * Returns <code>true</code> if this document library file version is approved.
  361. *
  362. * @return <code>true</code> if this document library file version is approved; <code>false</code> otherwise
  363. */
  364. public boolean isApproved();
  365. /**
  366. * Returns <code>true</code> if this document library file version is a draft.
  367. *
  368. * @return <code>true</code> if this document library file version is a draft; <code>false</code> otherwise
  369. */
  370. public boolean isDraft();
  371. /**
  372. * Returns <code>true</code> if this document library file version is expired.
  373. *
  374. * @return <code>true</code> if this document library file version is expired; <code>false</code> otherwise
  375. */
  376. public boolean isExpired();
  377. /**
  378. * Returns <code>true</code> if this document library file version is pending.
  379. *
  380. * @return <code>true</code> if this document library file version is pending; <code>false</code> otherwise
  381. */
  382. public boolean isPending();
  383. public boolean isNew();
  384. public void setNew(boolean n);
  385. public boolean isCachedModel();
  386. public void setCachedModel(boolean cachedModel);
  387. public boolean isEscapedModel();
  388. public Serializable getPrimaryKeyObj();
  389. public void setPrimaryKeyObj(Serializable primaryKeyObj);
  390. public ExpandoBridge getExpandoBridge();
  391. public void setExpandoBridgeAttributes(ServiceContext serviceContext);
  392. public Object clone();
  393. public int compareTo(DLFileVersion dlFileVersion);
  394. public int hashCode();
  395. public CacheModel<DLFileVersion> toCacheModel();
  396. public DLFileVersion toEscapedModel();
  397. public String toString();
  398. public String toXmlString();
  399. }