Class RepositoryLocalServiceUtil
com.liferay.portal.service.impl.RepositoryLocalServiceImpl
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.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic Repository
addRepository
(Repository repository) Adds the repository to the database.static Repository
addRepository
(String externalReferenceCode, long userId, long groupId, long classNameId, long parentFolderId, String name, String description, String portletId, UnicodeProperties typeSettingsUnicodeProperties, boolean hidden, ServiceContext serviceContext) static void
checkRepository
(long repositoryId) static PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static Repository
createRepository
(long repositoryId) Creates a new repository with the primary key.static PersistedModel
deletePersistedModel
(PersistedModel persistedModel) static void
deleteRepositories
(long groupId) static Repository
deleteRepository
(long repositoryId) Deletes the repository with the primary key from the database.static Repository
deleteRepository
(Repository repository) Deletes the repository from the database.static <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static 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 Repository
fetchRepository
(long repositoryId) static Repository
fetchRepository
(long groupId, String portletId) static Repository
fetchRepository
(long groupId, String name, String portletId) static Repository
fetchRepositoryByExternalReferenceCode
(String externalReferenceCode, long groupId) static Repository
fetchRepositoryByUuidAndGroupId
(String uuid, long groupId) Returns the repository matching the UUID and group.static ActionableDynamicQuery
static ExportActionableDynamicQuery
getExportActionableDynamicQuery
(PortletDataContext portletDataContext) static List<Repository>
getGroupRepositories
(long groupId) static String
Returns the OSGi service identifier.static PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static List<Repository>
getRepositories
(int start, int end) Returns a range of all the repositories.static List<Repository>
getRepositoriesByUuidAndCompanyId
(String uuid, long companyId) Returns all the repositories matching the UUID and company.static List<Repository>
getRepositoriesByUuidAndCompanyId
(String uuid, long companyId, int start, int end, OrderByComparator<Repository> orderByComparator) Returns a range of repositories matching the UUID and company.static int
Returns the number of repositories.static Repository
getRepository
(long repositoryId) Returns the repository with the primary key.static Repository
getRepository
(long groupId, String portletId) static Repository
getRepository
(long groupId, String name, String portletId) static Repository
getRepositoryByExternalReferenceCode
(String externalReferenceCode, long groupId) static Repository
getRepositoryByUuidAndGroupId
(String uuid, long groupId) Returns the repository matching the UUID and group.static RepositoryLocalService
static UnicodeProperties
getTypeSettingsProperties
(long repositoryId) static void
setService
(RepositoryLocalService service) static void
updateRepository
(long repositoryId, UnicodeProperties typeSettingsUnicodeProperties) static void
updateRepository
(long repositoryId, String name, String description) static Repository
updateRepository
(Repository repository) Updates the repository in the database or adds it if it does not yet exist.
-
Constructor Details
-
RepositoryLocalServiceUtil
public RepositoryLocalServiceUtil()
-
-
Method Details
-
addRepository
Adds the repository to the database. Also notifies the appropriate model listeners.Important: Inspect RepositoryLocalServiceImpl 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:
repository
- the repository- Returns:
- the repository that was added
-
addRepository
public static Repository addRepository(String externalReferenceCode, long userId, long groupId, long classNameId, long parentFolderId, String name, String description, String portletId, UnicodeProperties typeSettingsUnicodeProperties, boolean hidden, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
checkRepository
public static void checkRepository(long repositoryId) -
createPersistedModel
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - Throws:
PortalException
-
createRepository
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
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException - Throws:
PortalException
-
deleteRepositories
- Throws:
PortalException
-
deleteRepository
Deletes the repository with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect RepositoryLocalServiceImpl 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:
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
Deletes the repository from the database. Also notifies the appropriate model listeners.Important: Inspect RepositoryLocalServiceImpl 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:
repository
- the repository- Returns:
- the repository that was removed
- Throws:
PortalException
-
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
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.RepositoryModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.RepositoryModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchRepository
-
fetchRepository
-
fetchRepository
-
fetchRepositoryByExternalReferenceCode
public static Repository fetchRepositoryByExternalReferenceCode(String externalReferenceCode, long groupId) -
fetchRepositoryByUuidAndGroupId
Returns the repository matching the UUID and group.- Parameters:
uuid
- the repository's UUIDgroupId
- the primary key of the group- Returns:
- the matching repository, or
null
if a matching repository could not be found
-
getActionableDynamicQuery
-
getExportActionableDynamicQuery
public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext) -
getGroupRepositories
-
getIndexableActionableDynamicQuery
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
getRepositories
Returns a range of all the repositories.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.RepositoryModelImpl
.- Parameters:
start
- the lower bound of the range of repositoriesend
- the upper bound of the range of repositories (not inclusive)- Returns:
- the range of repositories
-
getRepositoriesByUuidAndCompanyId
Returns all the repositories matching the UUID and company.- Parameters:
uuid
- the UUID of the repositoriescompanyId
- the primary key of the company- Returns:
- the matching repositories, or an empty list if no matches were found
-
getRepositoriesByUuidAndCompanyId
public static 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 repositoriescompanyId
- the primary key of the companystart
- the lower bound of the range of repositoriesend
- the upper bound of the range of repositories (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the range of matching repositories, or an empty list if no matches were found
-
getRepositoriesCount
public static int getRepositoriesCount()Returns the number of repositories.- Returns:
- the number of repositories
-
getRepository
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
- Throws:
PortalException
-
getRepository
public static Repository getRepository(long groupId, String name, String portletId) throws PortalException - Throws:
PortalException
-
getRepositoryByExternalReferenceCode
public static Repository getRepositoryByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Throws:
PortalException
-
getRepositoryByUuidAndGroupId
public static Repository getRepositoryByUuidAndGroupId(String uuid, long groupId) throws PortalException Returns the repository matching the UUID and group.- Parameters:
uuid
- the repository's UUIDgroupId
- the primary key of the group- Returns:
- the matching repository
- Throws:
PortalException
- if a matching repository could not be found
-
getTypeSettingsProperties
- Throws:
PortalException
-
updateRepository
public static void updateRepository(long repositoryId, String name, String description) throws PortalException - Throws:
PortalException
-
updateRepository
public static void updateRepository(long repositoryId, UnicodeProperties typeSettingsUnicodeProperties) throws PortalException - Throws:
PortalException
-
updateRepository
Updates the repository in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect RepositoryLocalServiceImpl 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:
repository
- the repository- Returns:
- the repository that was updated
-
getService
-
setService
-