Liferay 7.0-ce-b4

com.liferay.portal.service
Class RepositoryLocalServiceUtil

java.lang.Object
  extended by com.liferay.portal.service.RepositoryLocalServiceUtil

@ProviderType
public class RepositoryLocalServiceUtil
extends Object

Provides the local service utility for Repository. This utility wraps RepositoryLocalServiceImpl and is the primary 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:
RepositoryLocalService, RepositoryLocalServiceBaseImpl, RepositoryLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
RepositoryLocalServiceUtil()
           
 
Method Summary
static Repository addRepository(long userId, long groupId, long classNameId, long parentFolderId, String name, String description, String portletId, UnicodeProperties typeSettingsProperties, boolean hidden, ServiceContext serviceContext)
           
static Repository addRepository(long userId, long groupId, long classNameId, long parentFolderId, String name, String description, String portletId, UnicodeProperties typeSettingsProperties, ServiceContext serviceContext)
          Deprecated. As of 6.2.0, replaced by addRepository(long, long, long, long, String, String, String, UnicodeProperties, boolean, ServiceContext)
static Repository addRepository(Repository repository)
          Adds the repository to the database.
static void checkRepository(long repositoryId)
           
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 DynamicQuery 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 fetchRepositoryByUuidAndGroupId(String uuid, long groupId)
          Returns the repository matching the UUID and group.
static ActionableDynamicQuery getActionableDynamicQuery()
           
static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
           
static List<Repository> getGroupRepositories(long groupId)
           
static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
           
static String getOSGiServiceIdentifier()
          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 getRepositoriesCount()
          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 getRepositoryByUuidAndGroupId(String uuid, long groupId)
          Returns the repository matching the UUID and group.
static RepositoryLocalService getService()
           
static UnicodeProperties getTypeSettingsProperties(long repositoryId)
           
static void updateRepository(long repositoryId, String name, String description)
           
static void updateRepository(long repositoryId, UnicodeProperties typeSettingsProperties)
           
static Repository updateRepository(Repository repository)
          Updates the repository in the database or adds it if it does not yet exist.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RepositoryLocalServiceUtil

public RepositoryLocalServiceUtil()
Method Detail

addRepository

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

addRepository

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

@Deprecated
public static Repository addRepository(long userId,
                                                  long groupId,
                                                  long classNameId,
                                                  long parentFolderId,
                                                  String name,
                                                  String description,
                                                  String portletId,
                                                  UnicodeProperties typeSettingsProperties,
                                                  ServiceContext serviceContext)
                                throws PortalException
Deprecated. As of 6.2.0, replaced by addRepository(long, long, long, long, String, String, String, UnicodeProperties, boolean, ServiceContext)

Throws:
PortalException

checkRepository

public static void checkRepository(long repositoryId)

createRepository

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

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException
Throws:
PortalException

deleteRepositories

public static void deleteRepositories(long groupId)
                               throws PortalException
Throws:
PortalException

deleteRepository

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

deleteRepository

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

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

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

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

public static Repository fetchRepository(long groupId,
                                         String name,
                                         String portletId)

fetchRepository

public static Repository fetchRepository(long groupId,
                                         String portletId)

fetchRepository

public static Repository fetchRepository(long repositoryId)

fetchRepositoryByUuidAndGroupId

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

public static ActionableDynamicQuery getActionableDynamicQuery()

getExportActionableDynamicQuery

public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getGroupRepositories

public static List<Repository> getGroupRepositories(long groupId)

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

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

Returns:
the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException
Throws:
PortalException

getRepositories

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

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

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

public static int getRepositoriesCount()
Returns the number of repositories.

Returns:
the number of repositories

getRepository

public static Repository getRepository(long groupId,
                                       String name,
                                       String portletId)
                                throws PortalException
Throws:
PortalException

getRepository

public static Repository getRepository(long groupId,
                                       String portletId)
                                throws PortalException
Throws:
PortalException

getRepository

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

getRepositoryByUuidAndGroupId

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

public static UnicodeProperties getTypeSettingsProperties(long repositoryId)
                                                   throws PortalException
Throws:
PortalException

updateRepository

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

updateRepository

public static void updateRepository(long repositoryId,
                                    String name,
                                    String description)
                             throws PortalException
Throws:
PortalException

updateRepository

public static void updateRepository(long repositoryId,
                                    UnicodeProperties typeSettingsProperties)
                             throws PortalException
Throws:
PortalException

getService

public static RepositoryLocalService getService()

Liferay 7.0-ce-b4