Class WikiNodeLocalServiceUtil

java.lang.Object
com.liferay.wiki.service.WikiNodeLocalServiceUtil

public class WikiNodeLocalServiceUtil extends Object
Provides the local service utility for WikiNode. This utility wraps com.liferay.wiki.service.impl.WikiNodeLocalServiceImpl and is an 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:
Generated:
  • Constructor Details

    • WikiNodeLocalServiceUtil

      public WikiNodeLocalServiceUtil()
  • Method Details

    • addDefaultNode

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

      @Deprecated public static WikiNode addNode(long userId, String name, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Deprecated.
      As of Cavanaugh (7.4.x), replaced by addNode(String, long, String, String, ServiceContext)
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addNode

      public static WikiNode addNode(String externalReferenceCode, long userId, String name, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addNodeResources

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

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

      public static void addNodeResources(WikiNode node, com.liferay.portal.kernel.service.permission.ModelPermissions modelPermissions) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addWikiNode

      public static WikiNode addWikiNode(WikiNode wikiNode)
      Adds the wiki node to the database. Also notifies the appropriate model listeners.

      Important: Inspect WikiNodeLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      wikiNode - the wiki node
      Returns:
      the wiki node that was added
    • createPersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createWikiNode

      public static WikiNode createWikiNode(long nodeId)
      Creates a new wiki node with the primary key. Does not add the wiki node to the database.
      Parameters:
      nodeId - the primary key for the new wiki node
      Returns:
      the new wiki node
    • deleteNode

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

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

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

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

      public static WikiNode deleteWikiNode(long nodeId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the wiki node with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect WikiNodeLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      nodeId - the primary key of the wiki node
      Returns:
      the wiki node that was removed
      Throws:
      com.liferay.portal.kernel.exception.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.

      Important: Inspect WikiNodeLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      wikiNode - the wiki node
      Returns:
      the wiki node that was removed
    • dslQuery

      public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dslQueryCount

      public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dynamicQuery

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

      public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
      Performs a dynamic query on the database and returns the matching rows.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the matching rows
    • dynamicQuery

      public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end)
      Performs a dynamic query on the database and returns a range of the matching rows.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to 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

      public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
      Performs a dynamic query on the database and returns an ordered range of the matching rows.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to 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

      public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
      Returns the number of rows matching the dynamic query.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the number of rows matching the dynamic query
    • dynamicQueryCount

      public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
      Returns the number of rows matching the dynamic query.
      Parameters:
      dynamicQuery - the dynamic query
      projection - the projection to apply to the query
      Returns:
      the number of rows matching the dynamic query
    • fetchNode

      public static WikiNode fetchNode(long groupId, String name)
    • fetchNodeByUuidAndGroupId

      public static WikiNode fetchNodeByUuidAndGroupId(String uuid, long groupId)
    • fetchWikiNode

      public static WikiNode fetchWikiNode(long nodeId)
    • fetchWikiNodeByExternalReferenceCode

      public static WikiNode fetchWikiNodeByExternalReferenceCode(String externalReferenceCode, long groupId)
    • 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 com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • 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 com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

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

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

      public static WikiNode getNode(long groupId, String nodeName) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getNodes

      public static List<WikiNode> getNodes(long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getNodes

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

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

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

      public static int getNodesCount(long groupId)
    • getNodesCount

      public static int getNodesCount(long groupId, int status)
    • getOSGiServiceIdentifier

      public static String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getWikiNode

      public static WikiNode getWikiNode(long nodeId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the wiki node with the primary key.
      Parameters:
      nodeId - the primary key of the wiki node
      Returns:
      the wiki node
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a wiki node with the primary key could not be found
    • getWikiNodeByExternalReferenceCode

      public static WikiNode getWikiNodeByExternalReferenceCode(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getWikiNodeByUuidAndGroupId

      public static WikiNode getWikiNodeByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the wiki node matching the UUID and group.
      Parameters:
      uuid - the wiki node's UUID
      groupId - the primary key of the group
      Returns:
      the matching wiki node
      Throws:
      com.liferay.portal.kernel.exception.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 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

      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, com.liferay.portal.kernel.util.OrderByComparator<WikiNode> orderByComparator)
      Returns a range of wiki nodes matching the UUID and company.
      Parameters:
      uuid - the UUID of the wiki nodes
      companyId - the primary key of the company
      start - the lower bound of the range of wiki nodes
      end - the upper bound of the range of wiki nodes (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the range of matching wiki nodes, or an empty list if no matches were found
    • getWikiNodesCount

      public static int getWikiNodesCount()
      Returns the number of wiki nodes.
      Returns:
      the number of wiki nodes
    • importPages

      public static void importPages(long userId, long nodeId, InputStream[] inputStreams, Map<String,String[]> options) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • moveNodeToTrash

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

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

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

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

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

      public static WikiNode updateNode(long nodeId, String name, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateStatus

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

      public static WikiNode updateWikiNode(WikiNode wikiNode)
      Updates the wiki node in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect WikiNodeLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      wikiNode - the wiki node
      Returns:
      the wiki node that was updated
    • getService

      public static WikiNodeLocalService getService()