com.liferay.portlet.wiki.service

Class WikiNodeLocalServiceUtil

java.lang.Object

com.liferay.portlet.wiki.service.WikiNodeLocalServiceUtil

@ProviderType
public class WikiNodeLocalServiceUtil
extends java.lang.Object

Provides the local service utility for WikiNode. This utility wraps com.liferay.portlet.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.

Author:

Brian Wing Shun Chan

See Also:

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

Generated:

Constructor Summary

Constructors

Constructor and Description
WikiNodeLocalServiceUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static WikiNode	addDefaultNode(long userId, ServiceContext serviceContext)
static WikiNode	addNode(long userId, java.lang.String name, java.lang.String description, 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 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 DynamicQuery	dynamicQuery()
static java.util.List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static java.util.List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static java.util.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 long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match 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	fetchWikiNodeByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the wiki node with the matching UUID and company.
static WikiNode	fetchWikiNodeByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the wiki node matching the UUID and group.
static java.lang.String	getBeanIdentifier() Returns the Spring bean ID for this bean.
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 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 PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static WikiNodeLocalService	getService()
static WikiNode	getWikiNode(long nodeId) Returns the wiki node with the primary key.
static WikiNode	getWikiNodeByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the wiki node with the matching UUID and company.
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 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	setBeanIdentifier(java.lang.String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(WikiNodeLocalService service) Deprecated. As of 6.2.0
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, ServiceContext serviceContext)
static WikiNode	updateStatus(long userId, WikiNode node, int status, 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

addWikiNode

public static WikiNode addWikiNode(WikiNode wikiNode)
                            throws SystemException

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

Throws:

SystemException - if a system exception occurred

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

deleteWikiNode

public static WikiNode deleteWikiNode(long nodeId)
                               throws PortalException,
                                      SystemException

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

SystemException - if a system exception occurred

deleteWikiNode

public static WikiNode deleteWikiNode(WikiNode wikiNode)
                               throws SystemException

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static java.util.List dynamicQuery(DynamicQuery dynamicQuery)
                                   throws SystemException

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

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static java.util.List dynamicQuery(DynamicQuery dynamicQuery,
                          int start,
                          int end)
                                   throws SystemException

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static java.util.List dynamicQuery(DynamicQuery dynamicQuery,
                          int start,
                          int end,
                          OrderByComparator orderByComparator)
                                   throws SystemException

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

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                     Projection projection)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchWikiNode

public static WikiNode fetchWikiNode(long nodeId)
                              throws SystemException

Throws:

SystemException

fetchWikiNodeByUuidAndCompanyId

public static WikiNode fetchWikiNodeByUuidAndCompanyId(java.lang.String uuid,
                                       long companyId)
                                                throws SystemException

Returns the wiki node with the matching UUID and company.

Parameters:

uuid - the wiki node's UUID

companyId - the primary key of the company

Returns:

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

Throws:

SystemException - if a system exception occurred

fetchWikiNodeByUuidAndGroupId

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

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

Throws:

SystemException - if a system exception occurred

getWikiNode

public static WikiNode getWikiNode(long nodeId)
                            throws PortalException,
                                   SystemException

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

SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getWikiNodeByUuidAndCompanyId

public static WikiNode getWikiNodeByUuidAndCompanyId(java.lang.String uuid,
                                     long companyId)
                                              throws PortalException,
                                                     SystemException

Returns the wiki node with the matching UUID and company.

Parameters:

uuid - the wiki node's UUID

companyId - the primary key of the company

Returns:

the matching wiki node

Throws:

PortalException - if a matching wiki node could not be found

SystemException - if a system exception occurred

getWikiNodeByUuidAndGroupId

public static WikiNode getWikiNodeByUuidAndGroupId(java.lang.String uuid,
                                   long groupId)
                                            throws PortalException,
                                                   SystemException

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

SystemException - if a system exception occurred

getWikiNodes

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

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

Throws:

SystemException - if a system exception occurred

getWikiNodesCount

public static int getWikiNodesCount()
                             throws SystemException

Returns the number of wiki nodes.

Returns:

the number of wiki nodes

Throws:

SystemException - if a system exception occurred

updateWikiNode

public static WikiNode updateWikiNode(WikiNode wikiNode)
                               throws SystemException

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

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static java.lang.String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(java.lang.String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addDefaultNode

public static WikiNode addDefaultNode(long userId,
                      ServiceContext serviceContext)
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

addNode

public static WikiNode addNode(long userId,
               java.lang.String name,
               java.lang.String description,
               ServiceContext serviceContext)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

addNodeResources

public static void addNodeResources(long nodeId,
                    boolean addGroupPermissions,
                    boolean addGuestPermissions)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

addNodeResources

public static void addNodeResources(long nodeId,
                    java.lang.String[] groupPermissions,
                    java.lang.String[] guestPermissions)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

addNodeResources

public static void addNodeResources(WikiNode node,
                    boolean addGroupPermissions,
                    boolean addGuestPermissions)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

addNodeResources

public static void addNodeResources(WikiNode node,
                    java.lang.String[] groupPermissions,
                    java.lang.String[] guestPermissions)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

deleteNode

public static void deleteNode(long nodeId)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

deleteNode

public static void deleteNode(WikiNode node)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

deleteNodes

public static void deleteNodes(long groupId)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

fetchNode

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

Throws:

SystemException

fetchNodeByUuidAndGroupId

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

Throws:

SystemException

getCompanyNodes

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

Throws:

SystemException

getCompanyNodes

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

Throws:

SystemException

getCompanyNodesCount

public static int getCompanyNodesCount(long companyId)
                                throws SystemException

Throws:

SystemException

getCompanyNodesCount

public static int getCompanyNodesCount(long companyId,
                       int status)
                                throws SystemException

Throws:

SystemException

getNode

public static WikiNode getNode(long nodeId)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

getNode

public static WikiNode getNode(long groupId,
               java.lang.String nodeName)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

getNodes

public static java.util.List<WikiNode> getNodes(long groupId)
                                         throws PortalException,
                                                SystemException

Throws:

PortalException

SystemException

getNodes

public static java.util.List<WikiNode> getNodes(long groupId,
                                int status)
                                         throws PortalException,
                                                SystemException

Throws:

PortalException

SystemException

getNodes

public static java.util.List<WikiNode> getNodes(long groupId,
                                int start,
                                int end)
                                         throws PortalException,
                                                SystemException

Throws:

PortalException

SystemException

getNodes

public static java.util.List<WikiNode> getNodes(long groupId,
                                int status,
                                int start,
                                int end)
                                         throws PortalException,
                                                SystemException

Throws:

PortalException

SystemException

getNodesCount

public static int getNodesCount(long groupId)
                         throws SystemException

Throws:

SystemException

getNodesCount

public static int getNodesCount(long groupId,
                int status)
                         throws SystemException

Throws:

SystemException

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 PortalException,
                               SystemException

Throws:

PortalException

SystemException

moveNodeToTrash

public static WikiNode moveNodeToTrash(long userId,
                       long nodeId)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

moveNodeToTrash

public static WikiNode moveNodeToTrash(long userId,
                       WikiNode node)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

restoreNodeFromTrash

public static void restoreNodeFromTrash(long userId,
                        WikiNode node)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

subscribeNode

public static void subscribeNode(long userId,
                 long nodeId)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

unsubscribeNode

public static void unsubscribeNode(long userId,
                   long nodeId)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

updateNode

public static WikiNode updateNode(long nodeId,
                  java.lang.String name,
                  java.lang.String description,
                  ServiceContext serviceContext)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

updateStatus

public static WikiNode updateStatus(long userId,
                    WikiNode node,
                    int status,
                    ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

getService

public static WikiNodeLocalService getService()

setService

public void setService(WikiNodeLocalService service)

Deprecated. As of 6.2.0