Liferay 6.0.5

com.liferay.portal.service
Interface ClassNameLocalService

All Known Implementing Classes:
ClassNameLocalServiceBaseImpl, ClassNameLocalServiceImpl, ClassNameLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface ClassNameLocalService

The interface for the class name local service.

Never modify or reference this interface directly. Always use ClassNameLocalServiceUtil to access the class name local service. Add custom service methods to ClassNameLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

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:
ClassNameLocalServiceUtil, ClassNameLocalServiceBaseImpl, ClassNameLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 ClassName addClassName(ClassName className)
          Adds the class name to the database.
 ClassName addClassName(String value)
           
 void checkClassNames()
           
 ClassName createClassName(long classNameId)
          Creates a new class name with the primary key.
 void deleteClassName(ClassName className)
          Deletes the class name from the database.
 void deleteClassName(long classNameId)
          Deletes the class name with the primary key from the database.
 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)
          Counts the number of rows that match the dynamic query.
 ClassName getClassName(long classNameId)
          Gets the class name with the primary key.
 ClassName getClassName(String value)
           
 long getClassNameId(Class<?> classObj)
           
 long getClassNameId(String value)
           
 List<ClassName> getClassNames(int start, int end)
          Gets a range of all the class names.
 int getClassNamesCount()
          Gets the number of class names.
 ClassName updateClassName(ClassName className)
          Updates the class name in the database.
 ClassName updateClassName(ClassName className, boolean merge)
          Updates the class name in the database.
 

Method Detail

addClassName

ClassName addClassName(ClassName className)
                       throws SystemException
Adds the class name to the database. Also notifies the appropriate model listeners.

Parameters:
className - the class name to add
Returns:
the class name that was added
Throws:
SystemException - if a system exception occurred

createClassName

ClassName createClassName(long classNameId)
Creates a new class name with the primary key. Does not add the class name to the database.

Parameters:
classNameId - the primary key for the new class name
Returns:
the new class name

deleteClassName

void deleteClassName(long classNameId)
                     throws PortalException,
                            SystemException
Deletes the class name with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
classNameId - the primary key of the class name to delete
Throws:
PortalException - if a class name with the primary key could not be found
SystemException - if a system exception occurred

deleteClassName

void deleteClassName(ClassName className)
                     throws SystemException
Deletes the class name from the database. Also notifies the appropriate model listeners.

Parameters:
className - the class name to delete
Throws:
SystemException - if a system exception occurred

dynamicQuery

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

Parameters:
dynamicQuery - the dynamic query to search with
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 to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (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 to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

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

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

getClassName

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ClassName getClassName(long classNameId)
                       throws PortalException,
                              SystemException
Gets the class name with the primary key.

Parameters:
classNameId - the primary key of the class name to get
Returns:
the class name
Throws:
PortalException - if a class name with the primary key could not be found
SystemException - if a system exception occurred

getClassNames

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ClassName> getClassNames(int start,
                                                                       int end)
                              throws SystemException
Gets a range of all the class names.

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 class names to return
end - the upper bound of the range of class names to return (not inclusive)
Returns:
the range of class names
Throws:
SystemException - if a system exception occurred

getClassNamesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getClassNamesCount()
                       throws SystemException
Gets the number of class names.

Returns:
the number of class names
Throws:
SystemException - if a system exception occurred

updateClassName

ClassName updateClassName(ClassName className)
                          throws SystemException
Updates the class name in the database. Also notifies the appropriate model listeners.

Parameters:
className - the class name to update
Returns:
the class name that was updated
Throws:
SystemException - if a system exception occurred

updateClassName

ClassName updateClassName(ClassName className,
                          boolean merge)
                          throws SystemException
Updates the class name in the database. Also notifies the appropriate model listeners.

Parameters:
className - the class name to update
merge - whether to merge the class name 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 class name that was updated
Throws:
SystemException - if a system exception occurred

addClassName

ClassName addClassName(String value)
                       throws SystemException
Throws:
SystemException

checkClassNames

void checkClassNames()
                     throws SystemException
Throws:
SystemException

getClassName

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ClassName getClassName(String value)
                       throws SystemException
Throws:
SystemException

getClassNameId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long getClassNameId(Class<?> classObj)

getClassNameId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long getClassNameId(String value)

Liferay 6.0.5