com.liferay.portal.kernel.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.

Author:

Brian Wing Shun Chan

See Also:

ClassNameLocalServiceUtil, ClassNameLocalServiceBaseImpl, ClassNameLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
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.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
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.
ClassName	fetchByClassNameId(long classNameId)
ClassName	fetchClassName(long classNameId)
ClassName	fetchClassName(String value)
ActionableDynamicQuery	getActionableDynamicQuery()
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.
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
String	getRegistryName()
void	invalidate()
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)

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

addClassName

ClassName addClassName(String value)

checkClassNames

@Transactional(propagation=SUPPORTS,
               readOnly=true)
void checkClassNames()

createClassName

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

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

deleteClassName

@Indexable(type=DELETE)
ClassName deleteClassName(long classNameId)
                                           throws PortalException

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

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

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

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

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

fetchByClassNameId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ClassName fetchByClassNameId(long classNameId)

fetchClassName

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ClassName fetchClassName(long classNameId)

fetchClassName

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ClassName fetchClassName(String value)

getActionableDynamicQuery

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

getClassName

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ClassName getClassName(long classNameId)
                                                                                   throws PortalException

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

getClassName

@Skip
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
ClassName getClassName(String value)

getClassNameId

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

getClassNameId

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

getClassNames

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ClassName> getClassNames(int start,
                                                                                                 int end)

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

getClassNamesCount

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

Returns the number of class names.

Returns:

the number of class names

getIndexableActionableDynamicQuery

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

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

getRegistryName

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

invalidate

void invalidate()

updateClassName

@Indexable(type=REINDEX)
ClassName updateClassName(ClassName className)

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