com.liferay.wiki.service

Class WikiNodeLocalServiceUtil

java.lang.Object

com.liferay.wiki.service.WikiNodeLocalServiceUtil

@ProviderType
public class WikiNodeLocalServiceUtil
extends java.lang.Object

Provides the local service utility for WikiNode. This utility wraps com.liferay.wiki.service.impl.WikiNodeLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. 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.

See Also:

WikiNodeLocalService, com.liferay.wiki.service.base.WikiNodeLocalServiceBaseImpl, com.liferay.wiki.service.impl.WikiNodeLocalServiceImpl

Generated:

Constructor Summary

Constructors

Constructor and Description
WikiNodeLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static WikiNode	addDefaultNode(long userId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static WikiNode	addNode(long userId, java.lang.String name, java.lang.String description, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static void	addNodeResources(long nodeId, boolean addGroupPermissions, boolean addGuestPermissions)
static void	addNodeResources(long nodeId, java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
static void	addNodeResources(WikiNode node, boolean addGroupPermissions, boolean addGuestPermissions)
static void	addNodeResources(WikiNode node, java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
static WikiNode	addWikiNode(WikiNode wikiNode) Adds the wiki node to the database.
static WikiNode	createWikiNode(long nodeId) Creates a new wiki node with the primary key.
static void	deleteNode(long nodeId)
static void	deleteNode(WikiNode node)
static void	deleteNodes(long groupId)
static com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
static WikiNode	deleteWikiNode(long nodeId) Deletes the wiki node with the primary key from the database.
static WikiNode	deleteWikiNode(WikiNode wikiNode) Deletes the wiki node from the database.
static com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.
static WikiNode	fetchNode(long groupId, java.lang.String name)
static WikiNode	fetchNodeByUuidAndGroupId(java.lang.String uuid, long groupId)
static WikiNode	fetchWikiNode(long nodeId)
static WikiNode	fetchWikiNodeByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the wiki node matching the UUID and group.
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
static java.util.List<WikiNode>	getCompanyNodes(long companyId, int start, int end)
static java.util.List<WikiNode>	getCompanyNodes(long companyId, int status, int start, int end)
static int	getCompanyNodesCount(long companyId)
static int	getCompanyNodesCount(long companyId, int status)
static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery	getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static WikiNode	getNode(long nodeId)
static WikiNode	getNode(long groupId, java.lang.String nodeName)
static java.util.List<WikiNode>	getNodes(long groupId)
static java.util.List<WikiNode>	getNodes(long groupId, int status)
static java.util.List<WikiNode>	getNodes(long groupId, int start, int end)
static java.util.List<WikiNode>	getNodes(long groupId, int status, int start, int end)
static int	getNodesCount(long groupId)
static int	getNodesCount(long groupId, int status)
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static WikiNodeLocalService	getService()
static WikiNode	getWikiNode(long nodeId) Returns the wiki node with the primary key.
static WikiNode	getWikiNodeByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the wiki node matching the UUID and group.
static java.util.List<WikiNode>	getWikiNodes(int start, int end) Returns a range of all the wiki nodes.
static java.util.List<WikiNode>	getWikiNodesByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns all the wiki nodes matching the UUID and company.
static java.util.List<WikiNode>	getWikiNodesByUuidAndCompanyId(java.lang.String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<WikiNode> orderByComparator) Returns a range of wiki nodes matching the UUID and company.
static int	getWikiNodesCount() Returns the number of wiki nodes.
static void	importPages(long userId, long nodeId, java.lang.String importer, java.io.InputStream[] inputStreams, java.util.Map<java.lang.String,java.lang.String[]> options)
static WikiNode	moveNodeToTrash(long userId, long nodeId)
static WikiNode	moveNodeToTrash(long userId, WikiNode node)
static void	restoreNodeFromTrash(long userId, WikiNode node)
static void	subscribeNode(long userId, long nodeId)
static void	unsubscribeNode(long userId, long nodeId)
static WikiNode	updateNode(long nodeId, java.lang.String name, java.lang.String description, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static WikiNode	updateStatus(long userId, WikiNode node, int status, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static WikiNode	updateWikiNode(WikiNode wikiNode) Updates the wiki node in the database or adds it if it does not yet exist.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WikiNodeLocalServiceUtil

public WikiNodeLocalServiceUtil()

Method Detail

addDefaultNode

public static WikiNode addDefaultNode(long userId,
                                      com.liferay.portal.kernel.service.ServiceContext serviceContext)
                               throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addNode

public static WikiNode addNode(long userId,
                               java.lang.String name,
                               java.lang.String description,
                               com.liferay.portal.kernel.service.ServiceContext serviceContext)
                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addNodeResources

public static void addNodeResources(long nodeId,
                                    boolean addGroupPermissions,
                                    boolean addGuestPermissions)
                             throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addNodeResources

public static void addNodeResources(long nodeId,
                                    java.lang.String[] groupPermissions,
                                    java.lang.String[] guestPermissions)
                             throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addNodeResources

public static void addNodeResources(WikiNode node,
                                    boolean addGroupPermissions,
                                    boolean addGuestPermissions)
                             throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addNodeResources

public static void addNodeResources(WikiNode node,
                                    java.lang.String[] groupPermissions,
                                    java.lang.String[] guestPermissions)
                             throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addWikiNode

public static WikiNode addWikiNode(WikiNode wikiNode)

Adds the wiki node to the database. Also notifies the appropriate model listeners.

Parameters:

wikiNode - the wiki node

Returns:

the wiki node that was added

createWikiNode

public static WikiNode createWikiNode(long nodeId)

Creates a new wiki node with the primary key. Does not add the wiki node to the database.

Parameters:

nodeId - the primary key for the new wiki node

Returns:

the new wiki node

deleteNode

public static void deleteNode(long nodeId)
                       throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteNode

public static void deleteNode(WikiNode node)
                       throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteNodes

public static void deleteNodes(long groupId)
                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deletePersistedModel

public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

PortalException

deleteWikiNode

public static WikiNode deleteWikiNode(long nodeId)
                               throws com.liferay.portal.kernel.exception.PortalException

Deletes the wiki node with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

nodeId - the primary key of the wiki node

Returns:

the wiki node that was removed

Throws:

PortalException - if a wiki node with the primary key could not be found

deleteWikiNode

public static WikiNode deleteWikiNode(WikiNode wikiNode)

Deletes the wiki node from the database. Also notifies the appropriate model listeners.

Parameters:

wikiNode - the wiki node

Returns:

the wiki node that was removed

dynamicQuery

public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end)

Performs a dynamic query on the database and returns a range of the matching rows.

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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from WikiNodeModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end,
                                                 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)

Performs a dynamic query on the database and returns an ordered range of the matching rows.

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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from WikiNodeModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

dynamicQueryCount

public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                     com.liferay.portal.kernel.dao.orm.Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchNode

public static WikiNode fetchNode(long groupId,
                                 java.lang.String name)

fetchNodeByUuidAndGroupId

public static WikiNode fetchNodeByUuidAndGroupId(java.lang.String uuid,
                                                 long groupId)

fetchWikiNode

public static WikiNode fetchWikiNode(long nodeId)

fetchWikiNodeByUuidAndGroupId

public static WikiNode fetchWikiNodeByUuidAndGroupId(java.lang.String uuid,
                                                     long groupId)

Returns the wiki node matching the UUID and group.

Parameters:

uuid - the wiki node's UUID

groupId - the primary key of the group

Returns:

the matching wiki node, or null if a matching wiki node could not be found

getActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getCompanyNodes

public static java.util.List<WikiNode> getCompanyNodes(long companyId,
                                                       int start,
                                                       int end)

getCompanyNodes

public static java.util.List<WikiNode> getCompanyNodes(long companyId,
                                                       int status,
                                                       int start,
                                                       int end)

getCompanyNodesCount

public static int getCompanyNodesCount(long companyId)

getCompanyNodesCount

public static int getCompanyNodesCount(long companyId,
                                       int status)

getExportActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getNode

public static WikiNode getNode(long nodeId)
                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getNode

public static WikiNode getNode(long groupId,
                               java.lang.String nodeName)
                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getNodes

public static java.util.List<WikiNode> getNodes(long groupId)
                                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getNodes

public static java.util.List<WikiNode> getNodes(long groupId,
                                                int status)
                                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getNodes

public static java.util.List<WikiNode> getNodes(long groupId,
                                                int start,
                                                int end)
                                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getNodes

public static java.util.List<WikiNode> getNodes(long groupId,
                                                int status,
                                                int start,
                                                int end)
                                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getNodesCount

public static int getNodesCount(long groupId)

getNodesCount

public static int getNodesCount(long groupId,
                                int status)

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getWikiNode

public static WikiNode getWikiNode(long nodeId)
                            throws com.liferay.portal.kernel.exception.PortalException

Returns the wiki node with the primary key.

Parameters:

nodeId - the primary key of the wiki node

Returns:

the wiki node

Throws:

PortalException - if a wiki node with the primary key could not be found

getWikiNodeByUuidAndGroupId

public static WikiNode getWikiNodeByUuidAndGroupId(java.lang.String uuid,
                                                   long groupId)
                                            throws com.liferay.portal.kernel.exception.PortalException

Returns the wiki node matching the UUID and group.

Parameters:

uuid - the wiki node's UUID

groupId - the primary key of the group

Returns:

the matching wiki node

Throws:

PortalException - if a matching wiki node could not be found

getWikiNodes

public static java.util.List<WikiNode> getWikiNodes(int start,
                                                    int end)

Returns a range of all the wiki nodes.

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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from WikiNodeModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

start - the lower bound of the range of wiki nodes

end - the upper bound of the range of wiki nodes (not inclusive)

Returns:

the range of wiki nodes

getWikiNodesByUuidAndCompanyId

public static java.util.List<WikiNode> getWikiNodesByUuidAndCompanyId(java.lang.String uuid,
                                                                      long companyId)

Returns all the wiki nodes matching the UUID and company.

Parameters:

uuid - the UUID of the wiki nodes

companyId - the primary key of the company

Returns:

the matching wiki nodes, or an empty list if no matches were found

getWikiNodesByUuidAndCompanyId

public static java.util.List<WikiNode> getWikiNodesByUuidAndCompanyId(java.lang.String uuid,
                                                                      long companyId,
                                                                      int start,
                                                                      int end,
                                                                      com.liferay.portal.kernel.util.OrderByComparator<WikiNode> orderByComparator)

Returns a range of wiki nodes matching the UUID and company.

Parameters:

uuid - the UUID of the wiki nodes

companyId - the primary key of the company

start - the lower bound of the range of wiki nodes

end - the upper bound of the range of wiki nodes (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the range of matching wiki nodes, or an empty list if no matches were found

getWikiNodesCount

public static int getWikiNodesCount()

Returns the number of wiki nodes.

Returns:

the number of wiki nodes

importPages

public static void importPages(long userId,
                               long nodeId,
                               java.lang.String importer,
                               java.io.InputStream[] inputStreams,
                               java.util.Map<java.lang.String,java.lang.String[]> options)
                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

moveNodeToTrash

public static WikiNode moveNodeToTrash(long userId,
                                       long nodeId)
                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

moveNodeToTrash

public static WikiNode moveNodeToTrash(long userId,
                                       WikiNode node)
                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

restoreNodeFromTrash

public static void restoreNodeFromTrash(long userId,
                                        WikiNode node)
                                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

subscribeNode

public static void subscribeNode(long userId,
                                 long nodeId)
                          throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

unsubscribeNode

public static void unsubscribeNode(long userId,
                                   long nodeId)
                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateNode

public static WikiNode updateNode(long nodeId,
                                  java.lang.String name,
                                  java.lang.String description,
                                  com.liferay.portal.kernel.service.ServiceContext serviceContext)
                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateStatus

public static WikiNode updateStatus(long userId,
                                    WikiNode node,
                                    int status,
                                    com.liferay.portal.kernel.service.ServiceContext serviceContext)
                             throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateWikiNode

public static WikiNode updateWikiNode(WikiNode wikiNode)

Updates the wiki node in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

wikiNode - the wiki node

Returns:

the wiki node that was updated

getService

public static WikiNodeLocalService getService()