Liferay 6.1.2-ce-ga3

com.liferay.portal.service
Class ServiceComponentLocalServiceUtil

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

public class ServiceComponentLocalServiceUtil
extends Object

The utility for the service component local service. This utility wraps com.liferay.portal.service.impl.ServiceComponentLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

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:
ServiceComponentLocalService, ServiceComponentLocalServiceBaseImpl, com.liferay.portal.service.impl.ServiceComponentLocalServiceImpl

Constructor Summary
ServiceComponentLocalServiceUtil()
           
 
Method Summary
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 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(javax.servlet.ServletContext servletContext, ClassLoader classLoader)
           
static DynamicQuery dynamicQuery()
           
static List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static 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.
static long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
static ServiceComponent fetchServiceComponent(long serviceComponentId)
           
static String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
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(javax.servlet.ServletContext servletContext, ClassLoader classLoader, String buildNamespace, long buildNumber, long buildDate, boolean buildAutoUpgrade)
           
static void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setService(ServiceComponentLocalService service)
          Deprecated.  
static ServiceComponent updateServiceComponent(ServiceComponent serviceComponent)
          Updates the service component in the database or adds it if it does not yet exist.
static ServiceComponent updateServiceComponent(ServiceComponent serviceComponent, boolean merge)
          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)
           
static void verifyDB()
           
 
Methods inherited from class java.lang.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)
                                            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

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

deleteServiceComponent

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

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

public static DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

public static ServiceComponent fetchServiceComponent(long serviceComponentId)
                                              throws SystemException
Throws:
SystemException

getServiceComponent

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

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

getServiceComponents

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

public static int getServiceComponentsCount()
                                     throws SystemException
Returns the number of service components.

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

updateServiceComponent

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

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

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

Returns:
the Spring bean ID for this bean

setBeanIdentifier

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

Parameters:
beanIdentifier - the Spring bean ID for this bean

destroyServiceComponent

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

initServiceComponent

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

upgradeDB

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

verifyDB

public static void verifyDB()
                     throws SystemException
Throws:
SystemException

getService

public static ServiceComponentLocalService getService()

setService

public void setService(ServiceComponentLocalService service)
Deprecated. 


Liferay 6.1.2-ce-ga3