com.liferay.portal.kernel.service

Class ServiceComponentLocalServiceUtil

Object

com.liferay.portal.kernel.service.ServiceComponentLocalServiceUtil

@ProviderType
public class ServiceComponentLocalServiceUtil
extends Object

Provides the local service utility for ServiceComponent. This utility wraps ServiceComponentLocalServiceImpl 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.

Author:

Brian Wing Shun Chan

See Also:

ServiceComponentLocalService, ServiceComponentLocalServiceBaseImpl, ServiceComponentLocalServiceImpl

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
ServiceComponentLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static ServiceComponent	addServiceComponent(ServiceComponent serviceComponent) Adds the service component to the database.
static ServiceComponent	createServiceComponent(long serviceComponentId) Creates a new service component with the primary key.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static ServiceComponent	deleteServiceComponent(long serviceComponentId) Deletes the service component with the primary key from the database.
static ServiceComponent	deleteServiceComponent(ServiceComponent serviceComponent) Deletes the service component from the database.
static void	destroyServiceComponent(ServiceComponentConfiguration serviceComponentConfiguration, ClassLoader classLoader)
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 ServiceComponent	fetchServiceComponent(long serviceComponentId)
static ActionableDynamicQuery	getActionableDynamicQuery()
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static List<ServiceComponent>	getLatestServiceComponents()
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static ServiceComponentLocalService	getService()
static ServiceComponent	getServiceComponent(long serviceComponentId) Returns the service component with the primary key.
static List<ServiceComponent>	getServiceComponents(int start, int end) Returns a range of all the service components.
static int	getServiceComponentsCount() Returns the number of service components.
static ServiceComponent	initServiceComponent(ServiceComponentConfiguration serviceComponentConfiguration, ClassLoader classLoader, String buildNamespace, long buildNumber, long buildDate)
static ServiceComponent	initServiceComponent(ServiceComponentConfiguration serviceComponentConfiguration, ClassLoader classLoader, String buildNamespace, long buildNumber, long buildDate, boolean buildAutoUpgrade) Deprecated. As of Judson (7.1.x), replaced by initServiceComponent(ServiceComponentConfiguration, ClassLoader, String, long, long)
static ServiceComponent	updateServiceComponent(ServiceComponent serviceComponent) Updates the service component in the database or adds it if it does not yet exist.
static void	upgradeDB(ClassLoader classLoader, String buildNamespace, long buildNumber, boolean buildAutoUpgrade, ServiceComponent previousServiceComponent, String tablesSQL, String sequencesSQL, String indexesSQL) Deprecated. As of Judson (7.1.x), replaced by upgradeDB(ClassLoader, String, long, ServiceComponent, String, String, String)
static void	upgradeDB(ClassLoader classLoader, String buildNamespace, long buildNumber, ServiceComponent previousServiceComponent, String tablesSQL, String sequencesSQL, String indexesSQL)
static void	verifyDB()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServiceComponentLocalServiceUtil

public ServiceComponentLocalServiceUtil()

Method Detail

addServiceComponent

public static ServiceComponent addServiceComponent(ServiceComponent serviceComponent)

Adds the service component to the database. Also notifies the appropriate model listeners.

Parameters:

serviceComponent - the service component

Returns:

the service component that was added

createServiceComponent

public static ServiceComponent createServiceComponent(long serviceComponentId)

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

Parameters:

serviceComponentId - the primary key for the new service component

Returns:

the new service component

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

deleteServiceComponent

public static ServiceComponent deleteServiceComponent(long serviceComponentId)
                                               throws PortalException

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

Parameters:

serviceComponentId - the primary key of the service component

Returns:

the service component that was removed

Throws:

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

deleteServiceComponent

public static ServiceComponent deleteServiceComponent(ServiceComponent serviceComponent)

Deletes the service component from the database. Also notifies the appropriate model listeners.

Parameters:

serviceComponent - the service component

Returns:

the service component that was removed

destroyServiceComponent

public static void destroyServiceComponent(ServiceComponentConfiguration serviceComponentConfiguration,
                                           ClassLoader classLoader)

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

fetchServiceComponent

public static ServiceComponent fetchServiceComponent(long serviceComponentId)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getLatestServiceComponents

public static List<ServiceComponent> getLatestServiceComponents()

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

getServiceComponent

public static ServiceComponent getServiceComponent(long serviceComponentId)
                                            throws PortalException

Returns the service component with the primary key.

Parameters:

serviceComponentId - the primary key of the service component

Returns:

the service component

Throws:

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

getServiceComponents

public static List<ServiceComponent> getServiceComponents(int start,
                                                          int end)

Returns a range of all the service components.

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 ServiceComponentModelImpl. 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 service components

end - the upper bound of the range of service components (not inclusive)

Returns:

the range of service components

getServiceComponentsCount

public static int getServiceComponentsCount()

Returns the number of service components.

Returns:

the number of service components

initServiceComponent

public static ServiceComponent initServiceComponent(ServiceComponentConfiguration serviceComponentConfiguration,
                                                    ClassLoader classLoader,
                                                    String buildNamespace,
                                                    long buildNumber,
                                                    long buildDate)
                                             throws PortalException

Throws:

PortalException

initServiceComponent

@Deprecated
public static ServiceComponent initServiceComponent(ServiceComponentConfiguration serviceComponentConfiguration,
                                                                ClassLoader classLoader,
                                                                String buildNamespace,
                                                                long buildNumber,
                                                                long buildDate,
                                                                boolean buildAutoUpgrade)
                                                         throws PortalException

Deprecated. As of Judson (7.1.x), replaced by initServiceComponent(ServiceComponentConfiguration, ClassLoader, String, long, long)

Throws:

PortalException

updateServiceComponent

public static ServiceComponent updateServiceComponent(ServiceComponent serviceComponent)

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

Parameters:

serviceComponent - the service component

Returns:

the service component that was updated

upgradeDB

@Deprecated
public static void upgradeDB(ClassLoader classLoader,
                                         String buildNamespace,
                                         long buildNumber,
                                         boolean buildAutoUpgrade,
                                         ServiceComponent previousServiceComponent,
                                         String tablesSQL,
                                         String sequencesSQL,
                                         String indexesSQL)
                                  throws Exception

Deprecated. As of Judson (7.1.x), replaced by upgradeDB(ClassLoader, String, long, ServiceComponent, String, String, String)

Throws:

Exception

upgradeDB

public static void upgradeDB(ClassLoader classLoader,
                             String buildNamespace,
                             long buildNumber,
                             ServiceComponent previousServiceComponent,
                             String tablesSQL,
                             String sequencesSQL,
                             String indexesSQL)
                      throws Exception

Throws:

Exception

verifyDB

public static void verifyDB()

getService

public static ServiceComponentLocalService getService()