com.liferay.portal.kernel.service

Interface RepositoryLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

RepositoryLocalServiceWrapper

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

Provides the local service interface for Repository. 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:

RepositoryLocalServiceUtil, RepositoryLocalServiceBaseImpl, RepositoryLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
Repository	addRepository(long userId, long groupId, long classNameId, long parentFolderId, String name, String description, String portletId, UnicodeProperties typeSettingsProperties, boolean hidden, ServiceContext serviceContext)
Repository	addRepository(Repository repository) Adds the repository to the database.
void	checkRepository(long repositoryId)
Repository	createRepository(long repositoryId) Creates a new repository with the primary key.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
void	deleteRepositories(long groupId)
Repository	deleteRepository(long repositoryId) Deletes the repository with the primary key from the database.
Repository	deleteRepository(Repository repository) Deletes the repository 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.
Repository	fetchRepository(long repositoryId)
Repository	fetchRepository(long groupId, String portletId)
Repository	fetchRepository(long groupId, String name, String portletId)
Repository	fetchRepositoryByUuidAndGroupId(String uuid, long groupId) Returns the repository matching the UUID and group.
ActionableDynamicQuery	getActionableDynamicQuery()
ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
List<Repository>	getGroupRepositories(long groupId)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
List<Repository>	getRepositories(int start, int end) Returns a range of all the repositories.
List<Repository>	getRepositoriesByUuidAndCompanyId(String uuid, long companyId) Returns all the repositories matching the UUID and company.
List<Repository>	getRepositoriesByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<Repository> orderByComparator) Returns a range of repositories matching the UUID and company.
int	getRepositoriesCount() Returns the number of repositories.
Repository	getRepository(long repositoryId) Returns the repository with the primary key.
Repository	getRepository(long groupId, String portletId)
Repository	getRepository(long groupId, String name, String portletId)
Repository	getRepositoryByUuidAndGroupId(String uuid, long groupId) Returns the repository matching the UUID and group.
UnicodeProperties	getTypeSettingsProperties(long repositoryId)
void	updateRepository(long repositoryId, String name, String description)
void	updateRepository(long repositoryId, UnicodeProperties typeSettingsProperties)
Repository	updateRepository(Repository repository) Updates the repository in the database or adds it if it does not yet exist.

Method Detail

addRepository

Repository addRepository(long userId,
                         long groupId,
                         long classNameId,
                         long parentFolderId,
                         String name,
                         String description,
                         String portletId,
                         UnicodeProperties typeSettingsProperties,
                         boolean hidden,
                         ServiceContext serviceContext)
                  throws PortalException

Throws:

PortalException

addRepository

@Indexable(type=REINDEX)
Repository addRepository(Repository repository)

Adds the repository to the database. Also notifies the appropriate model listeners.

Parameters:

repository - the repository

Returns:

the repository that was added

checkRepository

void checkRepository(long repositoryId)

createRepository

@Transactional(enabled=false)
Repository createRepository(long repositoryId)

Creates a new repository with the primary key. Does not add the repository to the database.

Parameters:

repositoryId - the primary key for the new repository

Returns:

the new repository

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteRepositories

void deleteRepositories(long groupId)
                 throws PortalException

Throws:

PortalException

deleteRepository

@Indexable(type=DELETE)
Repository deleteRepository(long repositoryId)
                                             throws PortalException

Deletes the repository with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

repositoryId - the primary key of the repository

Returns:

the repository that was removed

Throws:

PortalException - if a repository with the primary key could not be found

deleteRepository

@Indexable(type=DELETE)
 @SystemEvent(action=1,
             type=1)
Repository deleteRepository(Repository repository)

Deletes the repository from the database. Also notifies the appropriate model listeners.

Parameters:

repository - the repository

Returns:

the repository that was removed

dynamicQuery

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

dynamicQuery

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

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

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

@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

fetchRepository

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Repository fetchRepository(long repositoryId)

fetchRepository

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Repository fetchRepository(long groupId,
                                                                                              String portletId)

fetchRepository

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Repository fetchRepository(long groupId,
                                                                                              String name,
                                                                                              String portletId)

fetchRepositoryByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Repository fetchRepositoryByUuidAndGroupId(String uuid,
                                                                                                              long groupId)

Returns the repository matching the UUID and group.

Parameters:

uuid - the repository's UUID

groupId - the primary key of the group

Returns:

the matching repository, or null if a matching repository could not be found

getActionableDynamicQuery

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

getExportActionableDynamicQuery

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

getGroupRepositories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Repository> getGroupRepositories(long groupId)

getIndexableActionableDynamicQuery

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

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

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

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getRepositories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Repository> getRepositories(int start,
                                                                                                    int end)

Returns a range of all the repositories.

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 RepositoryModelImpl. 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 repositories

end - the upper bound of the range of repositories (not inclusive)

Returns:

the range of repositories

getRepositoriesByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Repository> getRepositoriesByUuidAndCompanyId(String uuid,
                                                                                                                      long companyId)

Returns all the repositories matching the UUID and company.

Parameters:

uuid - the UUID of the repositories

companyId - the primary key of the company

Returns:

the matching repositories, or an empty list if no matches were found

getRepositoriesByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Repository> getRepositoriesByUuidAndCompanyId(String uuid,
                                                                                                                      long companyId,
                                                                                                                      int start,
                                                                                                                      int end,
                                                                                                                      OrderByComparator<Repository> orderByComparator)

Returns a range of repositories matching the UUID and company.

Parameters:

uuid - the UUID of the repositories

companyId - the primary key of the company

start - the lower bound of the range of repositories

end - the upper bound of the range of repositories (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the range of matching repositories, or an empty list if no matches were found

getRepositoriesCount

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

Returns the number of repositories.

Returns:

the number of repositories

getRepository

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Repository getRepository(long repositoryId)
                                                                                     throws PortalException

Returns the repository with the primary key.

Parameters:

repositoryId - the primary key of the repository

Returns:

the repository

Throws:

PortalException - if a repository with the primary key could not be found

getRepository

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Repository getRepository(long groupId,
                                                                                            String portletId)
                                                                                     throws PortalException

Throws:

PortalException

getRepository

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Repository getRepository(long groupId,
                                                                                            String name,
                                                                                            String portletId)
                                                                                     throws PortalException

Throws:

PortalException

getRepositoryByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Repository getRepositoryByUuidAndGroupId(String uuid,
                                                                                                            long groupId)
                                                                                                     throws PortalException

Returns the repository matching the UUID and group.

Parameters:

uuid - the repository's UUID

groupId - the primary key of the group

Returns:

the matching repository

Throws:

PortalException - if a matching repository could not be found

getTypeSettingsProperties

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UnicodeProperties getTypeSettingsProperties(long repositoryId)
                                                                                                        throws PortalException

Throws:

PortalException

updateRepository

void updateRepository(long repositoryId,
                      String name,
                      String description)
               throws PortalException

Throws:

PortalException

updateRepository

void updateRepository(long repositoryId,
                      UnicodeProperties typeSettingsProperties)
               throws PortalException

Throws:

PortalException

updateRepository

@Indexable(type=REINDEX)
Repository updateRepository(Repository repository)

Updates the repository in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

repository - the repository

Returns:

the repository that was updated