|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.liferay.portlet.wiki.service.WikiPageLocalServiceUtil
public class WikiPageLocalServiceUtil
The utility for the wiki page local service. This utility wraps com.liferay.portlet.wiki.service.impl.WikiPageLocalServiceImpl
and is the primary access point for service operations in application layer code running on the local server.
This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
WikiPageLocalService
,
com.liferay.portlet.wiki.service.base.WikiPageLocalServiceBaseImpl
,
com.liferay.portlet.wiki.service.impl.WikiPageLocalServiceImpl
Constructor Summary | |
---|---|
WikiPageLocalServiceUtil()
|
Method Summary | |
---|---|
static WikiPage |
addPage(long userId,
long nodeId,
String title,
double version,
String content,
String summary,
boolean minorEdit,
String format,
boolean head,
String parentTitle,
String redirectTitle,
ServiceContext serviceContext)
|
static WikiPage |
addPage(long userId,
long nodeId,
String title,
String content,
String summary,
boolean minorEdit,
ServiceContext serviceContext)
|
static void |
addPageAttachment(long userId,
long nodeId,
String title,
String fileName,
File file)
|
static void |
addPageAttachment(long userId,
long nodeId,
String title,
String fileName,
InputStream inputStream)
|
static void |
addPageAttachment(long companyId,
String dirName,
Date modifiedDate,
String fileName,
InputStream inputStream)
|
static void |
addPageAttachments(long userId,
long nodeId,
String title,
List<ObjectValuePair<String,InputStream>> inputStreams)
|
static void |
addPageResources(long nodeId,
String title,
boolean addGroupPermissions,
boolean addGuestPermissions)
|
static void |
addPageResources(long nodeId,
String title,
String[] groupPermissions,
String[] guestPermissions)
|
static void |
addPageResources(WikiPage page,
boolean addGroupPermissions,
boolean addGuestPermissions)
|
static void |
addPageResources(WikiPage page,
String[] groupPermissions,
String[] guestPermissions)
|
static String |
addTempPageAttachment(long userId,
String fileName,
String tempFolderName,
InputStream inputStream)
|
static WikiPage |
addWikiPage(WikiPage wikiPage)
Adds the wiki page to the database. |
static void |
changeParent(long userId,
long nodeId,
String title,
String newParentTitle,
ServiceContext serviceContext)
|
static WikiPage |
createWikiPage(long pageId)
Creates a new wiki page with the primary key. |
static void |
deletePage(long nodeId,
String title)
|
static void |
deletePage(long nodeId,
String title,
double version)
|
static void |
deletePage(WikiPage page)
|
static void |
deletePageAttachment(long nodeId,
String title,
String fileName)
|
static void |
deletePages(long nodeId)
|
static void |
deleteTempPageAttachment(long userId,
String fileName,
String tempFolderName)
|
static WikiPage |
deleteWikiPage(long pageId)
Deletes the wiki page with the primary key from the database. |
static WikiPage |
deleteWikiPage(WikiPage wikiPage)
Deletes the wiki page from the database. |
static DynamicQuery |
dynamicQuery()
|
static List |
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
static List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
static List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows. |
static long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows that match the dynamic query. |
static WikiPage |
fetchWikiPage(long pageId)
|
static String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
static List<WikiPage> |
getChildren(long nodeId,
boolean head,
String parentTitle)
|
static WikiPage |
getDraftPage(long nodeId,
String title)
|
static List<WikiPage> |
getIncomingLinks(long nodeId,
String title)
|
static List<WikiPage> |
getNoAssetPages()
|
static List<WikiPage> |
getOrphans(long nodeId)
|
static List<WikiPage> |
getOutgoingLinks(long nodeId,
String title)
|
static WikiPage |
getPage(long resourcePrimKey)
|
static WikiPage |
getPage(long resourcePrimKey,
Boolean head)
|
static WikiPage |
getPage(long nodeId,
String title)
|
static WikiPage |
getPage(long nodeId,
String title,
Boolean head)
|
static WikiPage |
getPage(long nodeId,
String title,
double version)
|
static WikiPage |
getPageByPageId(long pageId)
|
static WikiPageDisplay |
getPageDisplay(long nodeId,
String title,
PortletURL viewPageURL,
PortletURL editPageURL,
String attachmentURLPrefix)
|
static WikiPageDisplay |
getPageDisplay(WikiPage page,
PortletURL viewPageURL,
PortletURL editPageURL,
String attachmentURLPrefix)
|
static List<WikiPage> |
getPages(long nodeId,
boolean head,
int start,
int end)
|
static List<WikiPage> |
getPages(long nodeId,
boolean head,
int start,
int end,
OrderByComparator obc)
|
static List<WikiPage> |
getPages(long nodeId,
int start,
int end)
|
static List<WikiPage> |
getPages(long nodeId,
int start,
int end,
OrderByComparator obc)
|
static List<WikiPage> |
getPages(long resourcePrimKey,
long nodeId,
int status)
|
static List<WikiPage> |
getPages(long userId,
long nodeId,
int status,
int start,
int end)
|
static List<WikiPage> |
getPages(long nodeId,
String title,
boolean head,
int start,
int end)
|
static List<WikiPage> |
getPages(long nodeId,
String title,
int start,
int end)
|
static List<WikiPage> |
getPages(long nodeId,
String title,
int start,
int end,
OrderByComparator obc)
|
static List<WikiPage> |
getPages(String format)
|
static int |
getPagesCount(long nodeId)
|
static int |
getPagesCount(long nodeId,
boolean head)
|
static int |
getPagesCount(long userId,
long nodeId,
int status)
|
static int |
getPagesCount(long nodeId,
String title)
|
static int |
getPagesCount(long nodeId,
String title,
boolean head)
|
static int |
getPagesCount(String format)
|
static PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
static List<WikiPage> |
getRecentChanges(long nodeId,
int start,
int end)
Deprecated. getRecentChanges(long, long, int, int) |
static List<WikiPage> |
getRecentChanges(long groupId,
long nodeId,
int start,
int end)
|
static int |
getRecentChangesCount(long nodeId)
Deprecated. getRecentChangesCount(long, long) |
static int |
getRecentChangesCount(long groupId,
long nodeId)
|
static WikiPageLocalService |
getService()
|
static String[] |
getTempPageAttachmentNames(long userId,
String tempFolderName)
|
static WikiPage |
getWikiPage(long pageId)
Returns the wiki page with the primary key. |
static WikiPage |
getWikiPageByUuidAndGroupId(String uuid,
long groupId)
Returns the wiki page with the UUID in the group. |
static List<WikiPage> |
getWikiPages(int start,
int end)
Returns a range of all the wiki pages. |
static int |
getWikiPagesCount()
Returns the number of wiki pages. |
static boolean |
hasDraftPage(long nodeId,
String title)
|
static void |
movePage(long userId,
long nodeId,
String title,
String newTitle,
boolean strict,
ServiceContext serviceContext)
|
static void |
movePage(long userId,
long nodeId,
String title,
String newTitle,
ServiceContext serviceContext)
|
static WikiPage |
revertPage(long userId,
long nodeId,
String title,
double version,
ServiceContext serviceContext)
|
static void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
void |
setService(WikiPageLocalService service)
Deprecated. |
static void |
subscribePage(long userId,
long nodeId,
String title)
|
static void |
unsubscribePage(long userId,
long nodeId,
String title)
|
static void |
updateAsset(long userId,
WikiPage page,
long[] assetCategoryIds,
String[] assetTagNames,
long[] assetLinkEntryIds)
|
static WikiPage |
updatePage(long userId,
long nodeId,
String title,
double version,
String content,
String summary,
boolean minorEdit,
String format,
String parentTitle,
String redirectTitle,
ServiceContext serviceContext)
|
static WikiPage |
updateStatus(long userId,
long resourcePrimKey,
int status,
ServiceContext serviceContext)
|
static WikiPage |
updateStatus(long userId,
WikiPage page,
int status,
ServiceContext serviceContext)
|
static WikiPage |
updateWikiPage(WikiPage wikiPage)
Updates the wiki page in the database or adds it if it does not yet exist. |
static WikiPage |
updateWikiPage(WikiPage wikiPage,
boolean merge)
Updates the wiki page in the database or adds it if it does not yet exist. |
static void |
validateTitle(String title)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public WikiPageLocalServiceUtil()
Method Detail |
---|
public static WikiPage addWikiPage(WikiPage wikiPage) throws SystemException
wikiPage
- the wiki page
SystemException
- if a system exception occurredpublic static WikiPage createWikiPage(long pageId)
pageId
- the primary key for the new wiki page
public static WikiPage deleteWikiPage(long pageId) throws PortalException, SystemException
pageId
- the primary key of the wiki page
PortalException
- if a wiki page with the primary key could not be found
SystemException
- if a system exception occurredpublic static WikiPage deleteWikiPage(WikiPage wikiPage) throws SystemException
wikiPage
- the wiki page
SystemException
- if a system exception occurredpublic static DynamicQuery dynamicQuery()
public static List dynamicQuery(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query
SystemException
- if a system exception occurredpublic static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end) throws SystemException
Useful when paginating results. Returns a maximum of end - start
instances. start
and end
are not primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full result set.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)
SystemException
- if a system exception occurredpublic static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) throws SystemException
Useful when paginating results. Returns a maximum of end - start
instances. start
and end
are not primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full result set.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)
SystemException
- if a system exception occurredpublic static long dynamicQueryCount(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query
SystemException
- if a system exception occurredpublic static WikiPage fetchWikiPage(long pageId) throws SystemException
SystemException
public static WikiPage getWikiPage(long pageId) throws PortalException, SystemException
pageId
- the primary key of the wiki page
PortalException
- if a wiki page with the primary key could not be found
SystemException
- if a system exception occurredpublic static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException, SystemException
PortalException
SystemException
public static WikiPage getWikiPageByUuidAndGroupId(String uuid, long groupId) throws PortalException, SystemException
uuid
- the UUID of wiki pagegroupId
- the group id of the wiki page
PortalException
- if a wiki page with the UUID in the group could not be found
SystemException
- if a system exception occurredpublic static List<WikiPage> getWikiPages(int start, int end) throws SystemException
Useful when paginating results. Returns a maximum of end - start
instances. start
and end
are not primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full result set.
start
- the lower bound of the range of wiki pagesend
- the upper bound of the range of wiki pages (not inclusive)
SystemException
- if a system exception occurredpublic static int getWikiPagesCount() throws SystemException
SystemException
- if a system exception occurredpublic static WikiPage updateWikiPage(WikiPage wikiPage) throws SystemException
wikiPage
- the wiki page
SystemException
- if a system exception occurredpublic static WikiPage updateWikiPage(WikiPage wikiPage, boolean merge) throws SystemException
wikiPage
- the wiki pagemerge
- whether to merge the wiki page with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)
for an explanation.
SystemException
- if a system exception occurredpublic static String getBeanIdentifier()
public static void setBeanIdentifier(String beanIdentifier)
beanIdentifier
- the Spring bean ID for this beanpublic static WikiPage addPage(long userId, long nodeId, String title, double version, String content, String summary, boolean minorEdit, String format, boolean head, String parentTitle, String redirectTitle, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
public static WikiPage addPage(long userId, long nodeId, String title, String content, String summary, boolean minorEdit, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
public static void addPageAttachment(long userId, long nodeId, String title, String fileName, File file) throws PortalException, SystemException
PortalException
SystemException
public static void addPageAttachment(long userId, long nodeId, String title, String fileName, InputStream inputStream) throws PortalException, SystemException
PortalException
SystemException
public static void addPageAttachment(long companyId, String dirName, Date modifiedDate, String fileName, InputStream inputStream) throws PortalException, SystemException
PortalException
SystemException
public static void addPageAttachments(long userId, long nodeId, String title, List<ObjectValuePair<String,InputStream>> inputStreams) throws PortalException, SystemException
PortalException
SystemException
public static void addPageResources(long nodeId, String title, boolean addGroupPermissions, boolean addGuestPermissions) throws PortalException, SystemException
PortalException
SystemException
public static void addPageResources(long nodeId, String title, String[] groupPermissions, String[] guestPermissions) throws PortalException, SystemException
PortalException
SystemException
public static void addPageResources(WikiPage page, boolean addGroupPermissions, boolean addGuestPermissions) throws PortalException, SystemException
PortalException
SystemException
public static void addPageResources(WikiPage page, String[] groupPermissions, String[] guestPermissions) throws PortalException, SystemException
PortalException
SystemException
public static String addTempPageAttachment(long userId, String fileName, String tempFolderName, InputStream inputStream) throws PortalException, SystemException
PortalException
SystemException
public static void changeParent(long userId, long nodeId, String title, String newParentTitle, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
public static void deletePage(long nodeId, String title) throws PortalException, SystemException
PortalException
SystemException
public static void deletePage(long nodeId, String title, double version) throws PortalException, SystemException
PortalException
SystemException
public static void deletePage(WikiPage page) throws PortalException, SystemException
PortalException
SystemException
public static void deletePageAttachment(long nodeId, String title, String fileName) throws PortalException, SystemException
PortalException
SystemException
public static void deletePages(long nodeId) throws PortalException, SystemException
PortalException
SystemException
public static void deleteTempPageAttachment(long userId, String fileName, String tempFolderName) throws PortalException, SystemException
PortalException
SystemException
public static List<WikiPage> getChildren(long nodeId, boolean head, String parentTitle) throws SystemException
SystemException
public static WikiPage getDraftPage(long nodeId, String title) throws PortalException, SystemException
PortalException
SystemException
public static List<WikiPage> getIncomingLinks(long nodeId, String title) throws PortalException, SystemException
PortalException
SystemException
public static List<WikiPage> getNoAssetPages() throws SystemException
SystemException
public static List<WikiPage> getOrphans(long nodeId) throws PortalException, SystemException
PortalException
SystemException
public static List<WikiPage> getOutgoingLinks(long nodeId, String title) throws PortalException, SystemException
PortalException
SystemException
public static WikiPage getPage(long resourcePrimKey) throws PortalException, SystemException
PortalException
SystemException
public static WikiPage getPage(long resourcePrimKey, Boolean head) throws PortalException, SystemException
PortalException
SystemException
public static WikiPage getPage(long nodeId, String title) throws PortalException, SystemException
PortalException
SystemException
public static WikiPage getPage(long nodeId, String title, Boolean head) throws PortalException, SystemException
PortalException
SystemException
public static WikiPage getPage(long nodeId, String title, double version) throws PortalException, SystemException
PortalException
SystemException
public static WikiPage getPageByPageId(long pageId) throws PortalException, SystemException
PortalException
SystemException
public static WikiPageDisplay getPageDisplay(long nodeId, String title, PortletURL viewPageURL, PortletURL editPageURL, String attachmentURLPrefix) throws PortalException, SystemException
PortalException
SystemException
public static WikiPageDisplay getPageDisplay(WikiPage page, PortletURL viewPageURL, PortletURL editPageURL, String attachmentURLPrefix) throws PortalException, SystemException
PortalException
SystemException
public static List<WikiPage> getPages(long nodeId, boolean head, int start, int end) throws SystemException
SystemException
public static List<WikiPage> getPages(long nodeId, boolean head, int start, int end, OrderByComparator obc) throws SystemException
SystemException
public static List<WikiPage> getPages(long nodeId, int start, int end) throws SystemException
SystemException
public static List<WikiPage> getPages(long nodeId, int start, int end, OrderByComparator obc) throws SystemException
SystemException
public static List<WikiPage> getPages(long resourcePrimKey, long nodeId, int status) throws SystemException
SystemException
public static List<WikiPage> getPages(long userId, long nodeId, int status, int start, int end) throws SystemException
SystemException
public static List<WikiPage> getPages(long nodeId, String title, boolean head, int start, int end) throws SystemException
SystemException
public static List<WikiPage> getPages(long nodeId, String title, int start, int end) throws SystemException
SystemException
public static List<WikiPage> getPages(long nodeId, String title, int start, int end, OrderByComparator obc) throws SystemException
SystemException
public static List<WikiPage> getPages(String format) throws SystemException
SystemException
public static int getPagesCount(long nodeId) throws SystemException
SystemException
public static int getPagesCount(long nodeId, boolean head) throws SystemException
SystemException
public static int getPagesCount(long userId, long nodeId, int status) throws SystemException
SystemException
public static int getPagesCount(long nodeId, String title) throws SystemException
SystemException
public static int getPagesCount(long nodeId, String title, boolean head) throws SystemException
SystemException
public static int getPagesCount(String format) throws SystemException
SystemException
public static List<WikiPage> getRecentChanges(long nodeId, int start, int end) throws PortalException, SystemException
getRecentChanges(long, long, int, int)
PortalException
SystemException
public static List<WikiPage> getRecentChanges(long groupId, long nodeId, int start, int end) throws SystemException
SystemException
public static int getRecentChangesCount(long nodeId) throws PortalException, SystemException
getRecentChangesCount(long, long)
PortalException
SystemException
public static int getRecentChangesCount(long groupId, long nodeId) throws SystemException
SystemException
public static String[] getTempPageAttachmentNames(long userId, String tempFolderName)
public static boolean hasDraftPage(long nodeId, String title) throws SystemException
SystemException
public static void movePage(long userId, long nodeId, String title, String newTitle, boolean strict, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
public static void movePage(long userId, long nodeId, String title, String newTitle, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
public static WikiPage revertPage(long userId, long nodeId, String title, double version, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
public static void subscribePage(long userId, long nodeId, String title) throws PortalException, SystemException
PortalException
SystemException
public static void unsubscribePage(long userId, long nodeId, String title) throws PortalException, SystemException
PortalException
SystemException
public static void updateAsset(long userId, WikiPage page, long[] assetCategoryIds, String[] assetTagNames, long[] assetLinkEntryIds) throws PortalException, SystemException
PortalException
SystemException
public static WikiPage updatePage(long userId, long nodeId, String title, double version, String content, String summary, boolean minorEdit, String format, String parentTitle, String redirectTitle, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
public static WikiPage updateStatus(long userId, long resourcePrimKey, int status, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
public static WikiPage updateStatus(long userId, WikiPage page, int status, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
public static void validateTitle(String title) throws PortalException
PortalException
public static WikiPageLocalService getService()
public void setService(WikiPageLocalService service)
|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |