com.liferay.portlet.wiki.service

Interface WikiNodeLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

WikiNodeLocalServiceWrapper

@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface WikiNodeLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for WikiNode. 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:

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

Generated:

Method Summary

Methods

Modifier and Type	Method and Description
WikiNode	addDefaultNode(long userId, ServiceContext serviceContext)
WikiNode	addNode(long userId, java.lang.String name, java.lang.String description, ServiceContext serviceContext)
void	addNodeResources(long nodeId, boolean addGroupPermissions, boolean addGuestPermissions)
void	addNodeResources(long nodeId, java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
void	addNodeResources(WikiNode node, boolean addGroupPermissions, boolean addGuestPermissions)
void	addNodeResources(WikiNode node, java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
WikiNode	addWikiNode(WikiNode wikiNode) Adds the wiki node to the database.
WikiNode	createWikiNode(long nodeId) Creates a new wiki node with the primary key.
void	deleteNode(long nodeId)
void	deleteNode(WikiNode node)
void	deleteNodes(long groupId)
WikiNode	deleteWikiNode(long nodeId) Deletes the wiki node with the primary key from the database.
WikiNode	deleteWikiNode(WikiNode wikiNode) Deletes the wiki node from the database.
DynamicQuery	dynamicQuery()
java.util.List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
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.
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.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
WikiNode	fetchNode(long groupId, java.lang.String name)
WikiNode	fetchNodeByUuidAndGroupId(java.lang.String uuid, long groupId)
WikiNode	fetchWikiNode(long nodeId)
WikiNode	fetchWikiNodeByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the wiki node with the matching UUID and company.
WikiNode	fetchWikiNodeByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the wiki node matching the UUID and group.
java.lang.String	getBeanIdentifier() Returns the Spring bean ID for this bean.
java.util.List<WikiNode>	getCompanyNodes(long companyId, int start, int end)
java.util.List<WikiNode>	getCompanyNodes(long companyId, int status, int start, int end)
int	getCompanyNodesCount(long companyId)
int	getCompanyNodesCount(long companyId, int status)
WikiNode	getNode(long nodeId)
WikiNode	getNode(long groupId, java.lang.String nodeName)
java.util.List<WikiNode>	getNodes(long groupId)
java.util.List<WikiNode>	getNodes(long groupId, int status)
java.util.List<WikiNode>	getNodes(long groupId, int start, int end)
java.util.List<WikiNode>	getNodes(long groupId, int status, int start, int end)
int	getNodesCount(long groupId)
int	getNodesCount(long groupId, int status)
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
WikiNode	getWikiNode(long nodeId) Returns the wiki node with the primary key.
WikiNode	getWikiNodeByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the wiki node with the matching UUID and company.
WikiNode	getWikiNodeByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the wiki node matching the UUID and group.
java.util.List<WikiNode>	getWikiNodes(int start, int end) Returns a range of all the wiki nodes.
int	getWikiNodesCount() Returns the number of wiki nodes.
void	importPages(long userId, long nodeId, java.lang.String importer, java.io.InputStream[] inputStreams, java.util.Map<java.lang.String,java.lang.String[]> options)
WikiNode	moveNodeToTrash(long userId, long nodeId)
WikiNode	moveNodeToTrash(long userId, WikiNode node)
void	restoreNodeFromTrash(long userId, WikiNode node)
void	setBeanIdentifier(java.lang.String beanIdentifier) Sets the Spring bean ID for this bean.
void	subscribeNode(long userId, long nodeId)
void	unsubscribeNode(long userId, long nodeId)
WikiNode	updateNode(long nodeId, java.lang.String name, java.lang.String description, ServiceContext serviceContext)
WikiNode	updateStatus(long userId, WikiNode node, int status, ServiceContext serviceContext)
WikiNode	updateWikiNode(WikiNode wikiNode) Updates the wiki node in the database or adds it if it does not yet exist.

Method Detail

addWikiNode

@Indexable(type=REINDEX)
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

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

@Indexable(type=DELETE)
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

@Indexable(type=DELETE)
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

DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WikiNode fetchWikiNode(long nodeId)
                       throws SystemException

Throws:

SystemException

fetchWikiNodeByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

SystemException

getWikiNodeByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getWikiNodesCount()
                      throws SystemException

Returns the number of wiki nodes.

Returns:

the number of wiki nodes

Throws:

SystemException - if a system exception occurred

updateWikiNode

@Indexable(type=REINDEX)
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

java.lang.String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(java.lang.String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addDefaultNode

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

Throws:

PortalException

SystemException

addNode

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

Throws:

PortalException

SystemException

addNodeResources

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

Throws:

PortalException

SystemException

addNodeResources

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

Throws:

PortalException

SystemException

addNodeResources

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

Throws:

PortalException

SystemException

addNodeResources

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

Throws:

PortalException

SystemException

deleteNode

void deleteNode(long nodeId)
                throws PortalException,
                       SystemException

Throws:

PortalException

SystemException

deleteNode

@SystemEvent(action=1,
             type=1)
void deleteNode(WikiNode node)
                throws PortalException,
                       SystemException

Throws:

PortalException

SystemException

deleteNodes

void deleteNodes(long groupId)
                 throws PortalException,
                        SystemException

Throws:

PortalException

SystemException

fetchNode

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WikiNode fetchNode(long groupId,
                                                          java.lang.String name)
                   throws SystemException

Throws:

SystemException

fetchNodeByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WikiNode fetchNodeByUuidAndGroupId(java.lang.String uuid,
                                                                          long groupId)
                                   throws SystemException

Throws:

SystemException

getCompanyNodes

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<WikiNode> getCompanyNodes(long companyId,
                                                                                int start,
                                                                                int end)
                                         throws SystemException

Throws:

SystemException

getCompanyNodes

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<WikiNode> getCompanyNodes(long companyId,
                                                                                int status,
                                                                                int start,
                                                                                int end)
                                         throws SystemException

Throws:

SystemException

getCompanyNodesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCompanyNodesCount(long companyId)
                         throws SystemException

Throws:

SystemException

getCompanyNodesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCompanyNodesCount(long companyId,
                                                                int status)
                         throws SystemException

Throws:

SystemException

getNode

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WikiNode getNode(long nodeId)
                 throws PortalException,
                        SystemException

Throws:

PortalException

SystemException

getNode

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WikiNode getNode(long groupId,
                                                        java.lang.String nodeName)
                 throws PortalException,
                        SystemException

Throws:

PortalException

SystemException

getNodes

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<WikiNode> getNodes(long groupId)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

getNodes

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<WikiNode> getNodes(long groupId,
                                                                         int status)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

getNodes

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<WikiNode> getNodes(long groupId,
                                                                         int start,
                                                                         int end)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

getNodes

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<WikiNode> getNodes(long groupId,
                                                                         int status,
                                                                         int start,
                                                                         int end)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

getNodesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getNodesCount(long groupId)
                  throws SystemException

Throws:

SystemException

getNodesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getNodesCount(long groupId,
                                                         int status)
                  throws SystemException

Throws:

SystemException

importPages

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

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

Throws:

PortalException

SystemException

moveNodeToTrash

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

Throws:

PortalException

SystemException

restoreNodeFromTrash

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

Throws:

PortalException

SystemException

subscribeNode

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

Throws:

PortalException

SystemException

unsubscribeNode

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

Throws:

PortalException

SystemException

updateNode

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

Throws:

PortalException

SystemException

updateStatus

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

Throws:

PortalException

SystemException