com.liferay.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.

See Also:

WikiNodeLocalServiceUtil

Method Summary

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)
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
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()
<T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> 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 matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
WikiNode	fetchNode(long groupId, java.lang.String name)
WikiNode	fetchNodeByUuidAndGroupId(java.lang.String uuid, long groupId)
WikiNode	fetchWikiNode(long nodeId)
WikiNode	fetchWikiNodeByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the wiki node matching the UUID and group.
ActionableDynamicQuery	getActionableDynamicQuery()
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)
ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
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)
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
WikiNode	getWikiNode(long nodeId) Returns the wiki node with the primary key.
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.
java.util.List<WikiNode>	getWikiNodesByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns all the wiki nodes matching the UUID and company.
java.util.List<WikiNode>	getWikiNodesByUuidAndCompanyId(java.lang.String uuid, long companyId, int start, int end, OrderByComparator<WikiNode> orderByComparator) Returns a range of wiki nodes matching the UUID and company.
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	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

addDefaultNode

WikiNode addDefaultNode(long userId,
                        ServiceContext serviceContext)
                 throws PortalException

Throws:

PortalException

addNode

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

Throws:

PortalException

addNodeResources

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

Throws:

PortalException

addNodeResources

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

Throws:

PortalException

addNodeResources

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

Throws:

PortalException

addNodeResources

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

Throws:

PortalException

addWikiNode

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

@Transactional(enabled=false)
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

void deleteNode(long nodeId)
         throws PortalException

Throws:

PortalException

deleteNode

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

Throws:

PortalException

deleteNodes

void deleteNodes(long groupId)
          throws PortalException

Throws:

PortalException

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteWikiNode

@Indexable(type=DELETE)
WikiNode deleteWikiNode(long nodeId)
                                         throws 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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery)

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

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.wiki.model.impl.WikiNodeModelImpl.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                                      int start,
                                                                                                      int end,
                                                                                                      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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.wiki.model.impl.WikiNodeModelImpl.

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

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

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

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

fetchNodeByUuidAndGroupId

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

fetchWikiNode

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

fetchWikiNodeByUuidAndGroupId

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getCompanyNodes

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

getCompanyNodes

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

getCompanyNodesCount

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

getCompanyNodesCount

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

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getNode

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

Throws:

PortalException

getNode

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

Throws:

PortalException

getNodes

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

Throws:

PortalException

getNodes

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

Throws:

PortalException

getNodes

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

Throws:

PortalException

getNodes

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

Throws:

PortalException

getNodesCount

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

getNodesCount

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

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

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

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getWikiNode

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WikiNode getWikiNode(long nodeId)
                                                                                 throws 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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WikiNode getWikiNodeByUuidAndGroupId(java.lang.String uuid,
                                                                                                        long groupId)
                                                                                                 throws 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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.wiki.model.impl.WikiNodeModelImpl.

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<WikiNode> getWikiNodesByUuidAndCompanyId(java.lang.String uuid,
                                                                                                                           long companyId,
                                                                                                                           int start,
                                                                                                                           int end,
                                                                                                                           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

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

Returns the number of wiki nodes.

Returns:

the number of wiki nodes

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

Throws:

PortalException

moveNodeToTrash

WikiNode moveNodeToTrash(long userId,
                         long nodeId)
                  throws PortalException

Throws:

PortalException

moveNodeToTrash

WikiNode moveNodeToTrash(long userId,
                         WikiNode node)
                  throws PortalException

Throws:

PortalException

restoreNodeFromTrash

void restoreNodeFromTrash(long userId,
                          WikiNode node)
                   throws PortalException

Throws:

PortalException

subscribeNode

void subscribeNode(long userId,
                   long nodeId)
            throws PortalException

Throws:

PortalException

unsubscribeNode

void unsubscribeNode(long userId,
                     long nodeId)
              throws PortalException

Throws:

PortalException

updateNode

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

Throws:

PortalException

updateStatus

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

Throws:

PortalException

updateWikiNode

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