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.

Author:

Brian Wing Shun Chan

See Also:

WikiPageResourceLocalServiceUtil, com.liferay.portlet.wiki.service.base.WikiPageResourceLocalServiceBaseImpl, com.liferay.portlet.wiki.service.impl.WikiPageResourceLocalServiceImpl

Generated:

Method Summary

Methods

Modifier and Type	Method and Description
WikiPageResource	addPageResource(long nodeId, java.lang.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, java.lang.String title)
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()
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.
WikiPageResource	fetchPageResource(long nodeId, java.lang.String title)
WikiPageResource	fetchPageResource(java.lang.String uuid)
WikiPageResource	fetchWikiPageResource(long resourcePrimKey)
java.lang.String	getBeanIdentifier() Returns the Spring bean ID for this bean.
WikiPageResource	getPageResource(long pageResourcePrimKey)
WikiPageResource	getPageResource(long nodeId, java.lang.String title)
long	getPageResourcePrimKey(long nodeId, java.lang.String title)
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
WikiPageResource	getWikiPageResource(long resourcePrimKey) Returns the wiki page resource with the primary key.
java.util.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(java.lang.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

addWikiPageResource

@Indexable(type=REINDEX)
WikiPageResource addWikiPageResource(WikiPageResource wikiPageResource)
                                     throws SystemException

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

Throws:

SystemException - if a system exception occurred

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

deleteWikiPageResource

@Indexable(type=DELETE)
WikiPageResource deleteWikiPageResource(long resourcePrimKey)
                                        throws PortalException,
                                               SystemException

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

SystemException - if a system exception occurred

deleteWikiPageResource

@Indexable(type=DELETE)
WikiPageResource deleteWikiPageResource(WikiPageResource wikiPageResource)
                                        throws SystemException

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

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

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

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

fetchWikiPageResource

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

Throws:

SystemException

getWikiPageResource

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WikiPageResource getWikiPageResource(long resourcePrimKey)
                                     throws PortalException,
                                            SystemException

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

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

getWikiPageResources

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<WikiPageResource> getWikiPageResources(int start,
                                                                                             int end)
                                                      throws SystemException

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

Throws:

SystemException - if a system exception occurred

getWikiPageResourcesCount

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

Returns the number of wiki page resources.

Returns:

the number of wiki page resources

Throws:

SystemException - if a system exception occurred

updateWikiPageResource

@Indexable(type=REINDEX)
WikiPageResource updateWikiPageResource(WikiPageResource wikiPageResource)
                                        throws SystemException

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

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

addPageResource

WikiPageResource addPageResource(long nodeId,
                               java.lang.String title)
                                 throws SystemException

Throws:

SystemException

deletePageResource

void deletePageResource(long nodeId,
                      java.lang.String title)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

fetchPageResource

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WikiPageResource fetchPageResource(long nodeId,
                                                                          java.lang.String title)
                                   throws SystemException

Throws:

SystemException

fetchPageResource

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WikiPageResource fetchPageResource(java.lang.String uuid)
                                   throws SystemException

Throws:

SystemException

getPageResource

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

Throws:

PortalException

SystemException

getPageResource

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WikiPageResource getPageResource(long nodeId,
                                                                        java.lang.String title)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

getPageResourcePrimKey

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long getPageResourcePrimKey(long nodeId,
                                                                   java.lang.String title)
                            throws SystemException

Throws:

SystemException