Liferay 7.0-ce-m3

com.liferay.portlet.wiki.service
Interface WikiPageResourceLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
WikiPageResourceLocalServiceWrapper

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

Provides the local service interface for WikiPageResource. 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:
WikiPageResourceLocalServiceUtil, com.liferay.portlet.wiki.service.base.WikiPageResourceLocalServiceBaseImpl, com.liferay.portlet.wiki.service.impl.WikiPageResourceLocalServiceImpl

Method Summary
 WikiPageResource addPageResource(long nodeId, String title)
           
 WikiPageResource addWikiPageResource(WikiPageResource wikiPageResource)
          Adds the wiki page resource to the database.
 WikiPageResource createWikiPageResource(long resourcePrimKey)
          Creates a new wiki page resource with the primary key.
 void deletePageResource(long nodeId, String title)
           
 PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
 WikiPageResource deleteWikiPageResource(long resourcePrimKey)
          Deletes the wiki page resource with the primary key from the database.
 WikiPageResource deleteWikiPageResource(WikiPageResource wikiPageResource)
          Deletes the wiki page resource from the database.
 DynamicQuery dynamicQuery()
           
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
<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.
<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.
 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.
 WikiPageResource fetchPageResource(long nodeId, String title)
           
 WikiPageResource fetchPageResource(String uuid)
           
 WikiPageResource fetchWikiPageResource(long resourcePrimKey)
           
 ActionableDynamicQuery getActionableDynamicQuery()
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 WikiPageResource getPageResource(long pageResourcePrimKey)
           
 WikiPageResource getPageResource(long nodeId, String title)
           
 long getPageResourcePrimKey(long nodeId, String title)
           
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 WikiPageResource getWikiPageResource(long resourcePrimKey)
          Returns the wiki page resource with the primary key.
 List<WikiPageResource> getWikiPageResources(int start, int end)
          Returns a range of all the wiki page resources.
 int getWikiPageResourcesCount()
          Returns the number of wiki page resources.
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 WikiPageResource updateWikiPageResource(WikiPageResource wikiPageResource)
          Updates the wiki page resource in the database or adds it if it does not yet exist.
 

Method Detail

addPageResource

WikiPageResource addPageResource(long nodeId,
                                 String title)

addWikiPageResource

@Indexable(type=REINDEX)
WikiPageResource addWikiPageResource(WikiPageResource wikiPageResource)
Adds the wiki page resource to the database. Also notifies the appropriate model listeners.

Parameters:
wikiPageResource - the wiki page resource
Returns:
the wiki page resource that was added

createWikiPageResource

WikiPageResource createWikiPageResource(long resourcePrimKey)
Creates a new wiki page resource with the primary key. Does not add the wiki page resource to the database.

Parameters:
resourcePrimKey - the primary key for the new wiki page resource
Returns:
the new wiki page resource

deletePageResource

void deletePageResource(long nodeId,
                        String title)
                        throws PortalException
Throws:
PortalException

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                    throws PortalException
Specified by:
deletePersistedModel in interface PersistedModelLocalService
Throws:
PortalException

deleteWikiPageResource

@Indexable(type=DELETE)
WikiPageResource deleteWikiPageResource(long resourcePrimKey)
                                        throws PortalException
Deletes the wiki page resource with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
resourcePrimKey - the primary key of the wiki page resource
Returns:
the wiki page resource that was removed
Throws:
PortalException - if a wiki page resource with the primary key could not be found

deleteWikiPageResource

@Indexable(type=DELETE)
WikiPageResource deleteWikiPageResource(WikiPageResource wikiPageResource)
Deletes the wiki page resource from the database. Also notifies the appropriate model listeners.

Parameters:
wikiPageResource - the wiki page resource
Returns:
the wiki page resource that was removed

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

<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

<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 com.liferay.portlet.wiki.model.impl.WikiPageResourceModelImpl. 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

<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 com.liferay.portlet.wiki.model.impl.WikiPageResourceModelImpl. 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

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

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

fetchPageResource

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WikiPageResource fetchPageResource(long nodeId,
                                                                            String title)

fetchPageResource

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WikiPageResource fetchPageResource(String uuid)

fetchWikiPageResource

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WikiPageResource fetchWikiPageResource(long resourcePrimKey)

getActionableDynamicQuery

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

getBeanIdentifier

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

Returns:
the Spring bean ID for this bean

getPageResource

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WikiPageResource getPageResource(long nodeId,
                                                                          String title)
                                 throws PortalException
Throws:
PortalException

getPageResource

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WikiPageResource getPageResource(long pageResourcePrimKey)
                                 throws PortalException
Throws:
PortalException

getPageResourcePrimKey

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long getPageResourcePrimKey(long nodeId,
                                                                     String title)

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException

getWikiPageResource

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WikiPageResource getWikiPageResource(long resourcePrimKey)
                                     throws PortalException
Returns the wiki page resource with the primary key.

Parameters:
resourcePrimKey - the primary key of the wiki page resource
Returns:
the wiki page resource
Throws:
PortalException - if a wiki page resource with the primary key could not be found

getWikiPageResources

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<WikiPageResource> getWikiPageResources(int start,
                                                                                     int end)
Returns a range of all the wiki page resources.

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 com.liferay.portlet.wiki.model.impl.WikiPageResourceModelImpl. 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 page resources
end - the upper bound of the range of wiki page resources (not inclusive)
Returns:
the range of wiki page resources

getWikiPageResourcesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getWikiPageResourcesCount()
Returns the number of wiki page resources.

Returns:
the number of wiki page resources

setBeanIdentifier

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

Parameters:
beanIdentifier - the Spring bean ID for this bean

updateWikiPageResource

@Indexable(type=REINDEX)
WikiPageResource updateWikiPageResource(WikiPageResource wikiPageResource)
Updates the wiki page resource in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
wikiPageResource - the wiki page resource
Returns:
the wiki page resource that was updated

Liferay 7.0-ce-m3