com.liferay.portal.kernel.service

Interface ServiceComponentLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

ServiceComponentLocalServiceWrapper

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

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

ServiceComponentLocalServiceUtil, ServiceComponentLocalServiceBaseImpl, ServiceComponentLocalServiceImpl

{$generated.description}

Method Summary

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

Method Detail

addServiceComponent

@Indexable(type=REINDEX)
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

@Transactional(enabled=false)
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

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteServiceComponent

@Indexable(type=DELETE)
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

@Indexable(type=DELETE)
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

void destroyServiceComponent(ServiceComponentConfiguration serviceComponentConfiguration,
                             ClassLoader classLoader)

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

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

@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

fetchServiceComponent

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ServiceComponent fetchServiceComponent(long serviceComponentId)

getActionableDynamicQuery

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

getIndexableActionableDynamicQuery

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

getLatestServiceComponents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ServiceComponent> getLatestServiceComponents()

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

getServiceComponent

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

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

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

Returns the number of service components.

Returns:

the number of service components

initServiceComponent

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

Throws:

PortalException

initServiceComponent

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

@Indexable(type=REINDEX)
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
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

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

Throws:

Exception

verifyDB

void verifyDB()