Liferay 7.0-ce-m3

com.liferay.portlet.wiki.service
Class WikiNodeLocalServiceUtil

java.lang.Object
  extended by com.liferay.portlet.wiki.service.WikiNodeLocalServiceUtil

@ProviderType
public class WikiNodeLocalServiceUtil
extends Object

Provides the local service utility for WikiNode. This utility wraps 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, WikiNodeLocalServiceBaseImpl, WikiNodeLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
WikiNodeLocalServiceUtil()
           
 
Method Summary
static WikiNode addDefaultNode(long userId, ServiceContext serviceContext)
           
static WikiNode addNode(long userId, String name, String description, ServiceContext serviceContext)
           
static void addNodeResources(long nodeId, boolean addGroupPermissions, boolean addGuestPermissions)
           
static void addNodeResources(long nodeId, String[] groupPermissions, String[] guestPermissions)
           
static void addNodeResources(WikiNode node, boolean addGroupPermissions, boolean addGuestPermissions)
           
static void addNodeResources(WikiNode node, String[] groupPermissions, 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 PersistedModel deletePersistedModel(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 DynamicQuery dynamicQuery()
           
static
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static
<T> 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.
static long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows matching the dynamic query.
static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows matching the dynamic query.
static WikiNode fetchNode(long groupId, String name)
           
static WikiNode fetchNodeByUuidAndGroupId(String uuid, long groupId)
           
static WikiNode fetchWikiNode(long nodeId)
           
static WikiNode fetchWikiNodeByUuidAndGroupId(String uuid, long groupId)
          Returns the wiki node matching the UUID and group.
static ActionableDynamicQuery getActionableDynamicQuery()
           
static String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
static List<WikiNode> getCompanyNodes(long companyId, int start, int end)
           
static List<WikiNode> getCompanyNodes(long companyId, int status, int start, int end)
           
static int getCompanyNodesCount(long companyId)
           
static int getCompanyNodesCount(long companyId, int status)
           
static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
           
static WikiNode getNode(long nodeId)
           
static WikiNode getNode(long groupId, String nodeName)
           
static List<WikiNode> getNodes(long groupId)
           
static List<WikiNode> getNodes(long groupId, int status)
           
static List<WikiNode> getNodes(long groupId, int start, int end)
           
static 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(Serializable primaryKeyObj)
           
static WikiNodeLocalService getService()
           
static WikiNode getWikiNode(long nodeId)
          Returns the wiki node with the primary key.
static WikiNode getWikiNodeByUuidAndGroupId(String uuid, long groupId)
          Returns the wiki node matching the UUID and group.
static List<WikiNode> getWikiNodes(int start, int end)
          Returns a range of all the wiki nodes.
static List<WikiNode> getWikiNodesByUuidAndCompanyId(String uuid, long companyId)
          Returns all the wiki nodes matching the UUID and company.
static List<WikiNode> getWikiNodesByUuidAndCompanyId(String uuid, long companyId, int start, int end, 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, String importer, InputStream[] inputStreams, Map<String,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(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, String name, 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

addDefaultNode

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

addNode

public static WikiNode addNode(long userId,
                               String name,
                               String description,
                               ServiceContext serviceContext)
                        throws PortalException
Throws:
PortalException

addNodeResources

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

addNodeResources

public static void addNodeResources(WikiNode node,
                                    String[] groupPermissions,
                                    String[] guestPermissions)
                             throws PortalException
Throws:
PortalException

addNodeResources

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

addNodeResources

public static void addNodeResources(long nodeId,
                                    String[] groupPermissions,
                                    String[] guestPermissions)
                             throws PortalException
Throws:
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(WikiNode node)
                       throws PortalException
Throws:
PortalException

deleteNode

public static void deleteNode(long nodeId)
                       throws PortalException
Throws:
PortalException

deleteNodes

public static void deleteNodes(long groupId)
                        throws PortalException
Throws:
PortalException

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException
Throws:
PortalException

deleteWikiNode

public static 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

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 DynamicQuery dynamicQuery()

dynamicQuery

public static <T> 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

public static <T> 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 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> 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 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(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(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

public static WikiNode fetchNode(long groupId,
                                 String name)

fetchNodeByUuidAndGroupId

public static WikiNode fetchNodeByUuidAndGroupId(String uuid,
                                                 long groupId)

fetchWikiNode

public static WikiNode fetchWikiNode(long nodeId)

fetchWikiNodeByUuidAndGroupId

public static WikiNode fetchWikiNodeByUuidAndGroupId(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 ActionableDynamicQuery getActionableDynamicQuery()

getBeanIdentifier

public static String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

getCompanyNodes

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

getCompanyNodes

public static 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 ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getNode

public static WikiNode getNode(long groupId,
                               String nodeName)
                        throws PortalException
Throws:
PortalException

getNode

public static WikiNode getNode(long nodeId)
                        throws PortalException
Throws:
PortalException

getNodes

public static List<WikiNode> getNodes(long groupId)
                               throws PortalException
Throws:
PortalException

getNodes

public static List<WikiNode> getNodes(long groupId,
                                      int start,
                                      int end)
                               throws PortalException
Throws:
PortalException

getNodes

public static List<WikiNode> getNodes(long groupId,
                                      int status)
                               throws PortalException
Throws:
PortalException

getNodes

public static List<WikiNode> getNodes(long groupId,
                                      int status,
                                      int start,
                                      int end)
                               throws PortalException
Throws:
PortalException

getNodesCount

public static int getNodesCount(long groupId)

getNodesCount

public static int getNodesCount(long groupId,
                                int status)

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException
Throws:
PortalException

getWikiNode

public static 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

public static WikiNode getWikiNodeByUuidAndGroupId(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

public static 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 List<WikiNode> getWikiNodesByUuidAndCompanyId(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 List<WikiNode> getWikiNodesByUuidAndCompanyId(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

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,
                               String importer,
                               InputStream[] inputStreams,
                               Map<String,String[]> options)
                        throws PortalException
Throws:
PortalException

moveNodeToTrash

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

moveNodeToTrash

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

restoreNodeFromTrash

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

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

subscribeNode

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

unsubscribeNode

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

updateNode

public static WikiNode updateNode(long nodeId,
                                  String name,
                                  String description,
                                  ServiceContext serviceContext)
                           throws PortalException
Throws:
PortalException

updateStatus

public static WikiNode updateStatus(long userId,
                                    WikiNode node,
                                    int status,
                                    ServiceContext serviceContext)
                             throws PortalException
Throws:
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()

setService

@Deprecated
public void setService(WikiNodeLocalService service)
Deprecated. As of 6.2.0


Liferay 7.0-ce-m3