Liferay 6.2-ce-ga5

com.liferay.portal.service
Interface ClassNameLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
ClassNameLocalServiceWrapper

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

Provides the local service interface for ClassName. 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, com.liferay.portal.service.impl.ClassNameLocalServiceImpl

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.
 ClassName deleteClassName(ClassName className)
          Deletes the class name from the database.
 ClassName deleteClassName(long classNameId)
          Deletes the class name with the primary key from the database.
 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.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
 ClassName fetchClassName(long classNameId)
           
 ClassName fetchClassName(String value)
           
 long fetchClassNameId(Class<?> clazz)
           
 long fetchClassNameId(String value)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 ClassName getClassName(long classNameId)
          Returns the class name with the primary key.
 ClassName getClassName(String value)
           
 long getClassNameId(Class<?> clazz)
           
 long getClassNameId(String value)
           
 List<ClassName> getClassNames(int start, int end)
          Returns a range of all the class names.
 int getClassNamesCount()
          Returns the number of class names.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 String getRegistryName()
           
 void invalidate()
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 ClassName updateClassName(ClassName className)
          Updates the class name in the database or adds it if it does not yet exist.
 

Method Detail

addClassName

@Indexable(type=REINDEX)
ClassName addClassName(ClassName className)
                       throws SystemException
Adds the class name to the database. Also notifies the appropriate model listeners.

Parameters:
className - the class name
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

@Indexable(type=DELETE)
ClassName 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
Returns:
the class name that was removed
Throws:
PortalException - if a class name with the primary key could not be found
SystemException - if a system exception occurred

deleteClassName

@Indexable(type=DELETE)
ClassName deleteClassName(ClassName className)
                          throws SystemException
Deletes the class name from the database. Also notifies the appropriate model listeners.

Parameters:
className - the class name
Returns:
the class name 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. 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 ClassNameModelImpl. 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
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. 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 ClassNameModelImpl. 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
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

dynamicQueryCount

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

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

fetchClassName

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ClassName fetchClassName(long classNameId)
                         throws SystemException
Throws:
SystemException

getClassName

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

Parameters:
classNameId - the primary key of the class name
Returns:
the class name
Throws:
PortalException - if a class name 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

getClassNames

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ClassName> getClassNames(int start,
                                                                       int end)
                              throws SystemException
Returns 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. 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 ClassNameModelImpl. 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 class names
end - the upper bound of the range of class names (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
Returns the number of class names.

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

updateClassName

@Indexable(type=REINDEX)
ClassName updateClassName(ClassName className)
                          throws SystemException
Updates the class name in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
className - the class name
Returns:
the class name 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

addClassName

ClassName addClassName(String value)
                       throws SystemException
Throws:
SystemException

checkClassNames

@Transactional(propagation=SUPPORTS,
               readOnly=true)
void checkClassNames()
                     throws SystemException
Throws:
SystemException

fetchClassName

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

fetchClassNameId

@Skip
@Transactional(propagation=SUPPORTS,
               readOnly=true)
long fetchClassNameId(Class<?> clazz)

fetchClassNameId

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

getClassName

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

getClassNameId

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

getClassNameId

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

getRegistryName

@Transactional(propagation=SUPPORTS,
               readOnly=true)
String getRegistryName()

invalidate

void invalidate()

Liferay 6.2-ce-ga5