Liferay 6.1.2-ce-ga3

com.liferay.portal.service
Interface ServiceComponentLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
ServiceComponentLocalServiceBaseImpl, ServiceComponentLocalServiceImpl, ServiceComponentLocalServiceWrapper

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

The interface for the service component local service.

This is a local service. 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:
ServiceComponentLocalServiceUtil, ServiceComponentLocalServiceBaseImpl, ServiceComponentLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 ServiceComponent addServiceComponent(ServiceComponent serviceComponent)
          Adds the service component to the database.
 ServiceComponent createServiceComponent(long serviceComponentId)
          Creates a new service component with the primary key.
 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(javax.servlet.ServletContext servletContext, ClassLoader classLoader)
           
 DynamicQuery dynamicQuery()
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator 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 that match the dynamic query.
 ServiceComponent fetchServiceComponent(long serviceComponentId)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 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(javax.servlet.ServletContext servletContext, ClassLoader classLoader, String buildNamespace, long buildNumber, long buildDate, boolean buildAutoUpgrade)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 ServiceComponent updateServiceComponent(ServiceComponent serviceComponent)
          Updates the service component in the database or adds it if it does not yet exist.
 ServiceComponent updateServiceComponent(ServiceComponent serviceComponent, boolean merge)
          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)
           
 void verifyDB()
           
 

Method Detail

addServiceComponent

ServiceComponent addServiceComponent(ServiceComponent serviceComponent)
                                     throws SystemException
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
Throws:
SystemException - if a system exception occurred

createServiceComponent

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

deleteServiceComponent

ServiceComponent deleteServiceComponent(long serviceComponentId)
                                        throws PortalException,
                                               SystemException
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
SystemException - if a system exception occurred

deleteServiceComponent

ServiceComponent deleteServiceComponent(ServiceComponent serviceComponent)
                                        throws SystemException
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
Throws:
SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException
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.

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
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException
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.

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
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchServiceComponent

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ServiceComponent fetchServiceComponent(long serviceComponentId)
                                       throws SystemException
Throws:
SystemException

getServiceComponent

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ServiceComponent getServiceComponent(long serviceComponentId)
                                     throws PortalException,
                                            SystemException
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
SystemException - if a system exception occurred

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getServiceComponents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ServiceComponent> getServiceComponents(int start,
                                                                                     int end)
                                            throws SystemException
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.

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
Throws:
SystemException - if a system exception occurred

getServiceComponentsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getServiceComponentsCount()
                              throws SystemException
Returns the number of service components.

Returns:
the number of service components
Throws:
SystemException - if a system exception occurred

updateServiceComponent

ServiceComponent updateServiceComponent(ServiceComponent serviceComponent)
                                        throws SystemException
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
Throws:
SystemException - if a system exception occurred

updateServiceComponent

ServiceComponent updateServiceComponent(ServiceComponent serviceComponent,
                                        boolean merge)
                                        throws SystemException
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
merge - whether to merge the service component with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
Returns:
the service component that was updated
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

destroyServiceComponent

void destroyServiceComponent(javax.servlet.ServletContext servletContext,
                             ClassLoader classLoader)
                             throws SystemException
Throws:
SystemException

initServiceComponent

ServiceComponent initServiceComponent(javax.servlet.ServletContext servletContext,
                                      ClassLoader classLoader,
                                      String buildNamespace,
                                      long buildNumber,
                                      long buildDate,
                                      boolean buildAutoUpgrade)
                                      throws PortalException,
                                             SystemException
Throws:
PortalException
SystemException

upgradeDB

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

verifyDB

void verifyDB()
              throws SystemException
Throws:
SystemException

Liferay 6.1.2-ce-ga3