com.liferay.portal.service.ClassNameLocalService Maven / Gradle / Ivy
/**
* Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.portal.service;
import aQute.bnd.annotation.ProviderType;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.search.IndexableType;
import com.liferay.portal.kernel.transaction.Isolation;
import com.liferay.portal.kernel.transaction.Propagation;
import com.liferay.portal.kernel.transaction.Transactional;
/**
* 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 ClassNameLocalServiceUtil
* @see com.liferay.portal.service.base.ClassNameLocalServiceBaseImpl
* @see com.liferay.portal.service.impl.ClassNameLocalServiceImpl
* @generated
*/
@ProviderType
@Transactional(isolation = Isolation.PORTAL, rollbackFor = {
PortalException.class, SystemException.class})
public interface ClassNameLocalService extends BaseLocalService,
PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link ClassNameLocalServiceUtil} to access the class name local service. Add custom service methods to {@link com.liferay.portal.service.impl.ClassNameLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
/**
* Adds the class name to the database. Also notifies the appropriate model listeners.
*
* @param className the class name
* @return the class name that was added
* @throws SystemException if a system exception occurred
*/
@com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
public com.liferay.portal.model.ClassName addClassName(
com.liferay.portal.model.ClassName className)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Creates a new class name with the primary key. Does not add the class name to the database.
*
* @param classNameId the primary key for the new class name
* @return the new class name
*/
public com.liferay.portal.model.ClassName createClassName(long classNameId);
/**
* Deletes the class name with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param classNameId the primary key of the class name
* @return the class name that was removed
* @throws PortalException if a class name with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
@com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
public com.liferay.portal.model.ClassName deleteClassName(long classNameId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Deletes the class name from the database. Also notifies the appropriate model listeners.
*
* @param className the class name
* @return the class name that was removed
* @throws SystemException if a system exception occurred
*/
@com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
public com.liferay.portal.model.ClassName deleteClassName(
com.liferay.portal.model.ClassName className)
throws com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
throws com.liferay.portal.kernel.exception.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 {@link com.liferay.portal.kernel.dao.orm.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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.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.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @return the range of matching rows
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end) throws com.liferay.portal.kernel.exception.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 {@link com.liferay.portal.kernel.dao.orm.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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.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.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null
)
* @return the ordered range of matching rows
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of rows that match the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows that match the dynamic query
* @throws SystemException if a system exception occurred
*/
public long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of rows that match the dynamic query.
*
* @param dynamicQuery the dynamic query
* @param projection the projection to apply to the query
* @return the number of rows that match the dynamic query
* @throws SystemException if a system exception occurred
*/
public long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
com.liferay.portal.kernel.dao.orm.Projection projection)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.ClassName fetchClassName(long classNameId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the class name with the primary key.
*
* @param classNameId the primary key of the class name
* @return the class name
* @throws PortalException if a class name with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.ClassName getClassName(long classNameId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
@Override
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.PersistedModel getPersistedModel(
java.io.Serializable primaryKeyObj)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.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 {@link com.liferay.portal.kernel.dao.orm.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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.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.
*
*
* @param start the lower bound of the range of class names
* @param end the upper bound of the range of class names (not inclusive)
* @return the range of class names
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getClassNames(
int start, int end)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of class names.
*
* @return the number of class names
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getClassNamesCount()
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Updates the class name in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param className the class name
* @return the class name that was updated
* @throws SystemException if a system exception occurred
*/
@com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
public com.liferay.portal.model.ClassName updateClassName(
com.liferay.portal.model.ClassName className)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the Spring bean ID for this bean.
*
* @return the Spring bean ID for this bean
*/
public java.lang.String getBeanIdentifier();
/**
* Sets the Spring bean ID for this bean.
*
* @param beanIdentifier the Spring bean ID for this bean
*/
public void setBeanIdentifier(java.lang.String beanIdentifier);
public com.liferay.portal.model.ClassName addClassName(
java.lang.String value)
throws com.liferay.portal.kernel.exception.SystemException;
@com.liferay.portal.kernel.transaction.Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public void checkClassNames()
throws com.liferay.portal.kernel.exception.SystemException;
@com.liferay.portal.kernel.spring.aop.Skip
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.ClassName fetchClassName(
java.lang.String value)
throws com.liferay.portal.kernel.exception.SystemException;
@com.liferay.portal.kernel.spring.aop.Skip
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long fetchClassNameId(java.lang.Class clazz);
@com.liferay.portal.kernel.spring.aop.Skip
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long fetchClassNameId(java.lang.String value);
@com.liferay.portal.kernel.spring.aop.Skip
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.ClassName getClassName(
java.lang.String value)
throws com.liferay.portal.kernel.exception.SystemException;
@com.liferay.portal.kernel.spring.aop.Skip
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long getClassNameId(java.lang.Class clazz);
@com.liferay.portal.kernel.spring.aop.Skip
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long getClassNameId(java.lang.String value);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.lang.String getRegistryName();
public void invalidate();
}