Liferay 6.2-ce-ga5

com.liferay.portal.service
Interface PhoneLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
PhoneLocalServiceBaseImpl, PhoneLocalServiceImpl, PhoneLocalServiceWrapper

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

Provides the local service interface for Phone. 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:
PhoneLocalServiceUtil, PhoneLocalServiceBaseImpl, PhoneLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 Phone addPhone(long userId, String className, long classPK, String number, String extension, int typeId, boolean primary)
          Deprecated. As of 6.2.0, replaced by addPhone(long, String, long, String, String, int, boolean, ServiceContext)
 Phone addPhone(long userId, String className, long classPK, String number, String extension, int typeId, boolean primary, ServiceContext serviceContext)
           
 Phone addPhone(Phone phone)
          Adds the phone to the database.
 Phone createPhone(long phoneId)
          Creates a new phone with the primary key.
 Phone deletePhone(long phoneId)
          Deletes the phone with the primary key from the database.
 Phone deletePhone(Phone phone)
          Deletes the phone from the database.
 void deletePhones(long companyId, String className, long classPK)
           
 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.
 Phone fetchPhone(long phoneId)
           
 Phone fetchPhoneByUuidAndCompanyId(String uuid, long companyId)
          Returns the phone with the matching UUID and company.
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 Phone getPhone(long phoneId)
          Returns the phone with the primary key.
 Phone getPhoneByUuidAndCompanyId(String uuid, long companyId)
          Returns the phone with the matching UUID and company.
 List<Phone> getPhones()
           
 List<Phone> getPhones(int start, int end)
          Returns a range of all the phones.
 List<Phone> getPhones(long companyId, String className, long classPK)
           
 int getPhonesCount()
          Returns the number of phones.
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 Phone updatePhone(long phoneId, String number, String extension, int typeId, boolean primary)
           
 Phone updatePhone(Phone phone)
          Updates the phone in the database or adds it if it does not yet exist.
 

Method Detail

addPhone

@Indexable(type=REINDEX)
Phone addPhone(Phone phone)
               throws SystemException
Adds the phone to the database. Also notifies the appropriate model listeners.

Parameters:
phone - the phone
Returns:
the phone that was added
Throws:
SystemException - if a system exception occurred

createPhone

Phone createPhone(long phoneId)
Creates a new phone with the primary key. Does not add the phone to the database.

Parameters:
phoneId - the primary key for the new phone
Returns:
the new phone

deletePhone

@Indexable(type=DELETE)
Phone deletePhone(long phoneId)
                  throws PortalException,
                         SystemException
Deletes the phone with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
phoneId - the primary key of the phone
Returns:
the phone that was removed
Throws:
PortalException - if a phone with the primary key could not be found
SystemException - if a system exception occurred

deletePhone

@Indexable(type=DELETE)
Phone deletePhone(Phone phone)
                  throws SystemException
Deletes the phone from the database. Also notifies the appropriate model listeners.

Parameters:
phone - the phone
Returns:
the phone 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 PhoneModelImpl. 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 PhoneModelImpl. 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

fetchPhone

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Phone fetchPhone(long phoneId)
                 throws SystemException
Throws:
SystemException

fetchPhoneByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Phone fetchPhoneByUuidAndCompanyId(String uuid,
                                                                            long companyId)
                                   throws SystemException
Returns the phone with the matching UUID and company.

Parameters:
uuid - the phone's UUID
companyId - the primary key of the company
Returns:
the matching phone, or null if a matching phone could not be found
Throws:
SystemException - if a system exception occurred

getPhone

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Phone getPhone(long phoneId)
               throws PortalException,
                      SystemException
Returns the phone with the primary key.

Parameters:
phoneId - the primary key of the phone
Returns:
the phone
Throws:
PortalException - if a phone 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

getPhoneByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Phone getPhoneByUuidAndCompanyId(String uuid,
                                                                          long companyId)
                                 throws PortalException,
                                        SystemException
Returns the phone with the matching UUID and company.

Parameters:
uuid - the phone's UUID
companyId - the primary key of the company
Returns:
the matching phone
Throws:
PortalException - if a matching phone could not be found
SystemException - if a system exception occurred

getPhones

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Phone> getPhones(int start,
                                                               int end)
                      throws SystemException
Returns a range of all the phones.

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 PhoneModelImpl. 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 phones
end - the upper bound of the range of phones (not inclusive)
Returns:
the range of phones
Throws:
SystemException - if a system exception occurred

getPhonesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getPhonesCount()
                   throws SystemException
Returns the number of phones.

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

updatePhone

@Indexable(type=REINDEX)
Phone updatePhone(Phone phone)
                  throws SystemException
Updates the phone in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
phone - the phone
Returns:
the phone 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

addPhone

Phone addPhone(long userId,
               String className,
               long classPK,
               String number,
               String extension,
               int typeId,
               boolean primary)
               throws PortalException,
                      SystemException
Deprecated. As of 6.2.0, replaced by addPhone(long, String, long, String, String, int, boolean, ServiceContext)

Throws:
PortalException
SystemException

addPhone

Phone addPhone(long userId,
               String className,
               long classPK,
               String number,
               String extension,
               int typeId,
               boolean primary,
               ServiceContext serviceContext)
               throws PortalException,
                      SystemException
Throws:
PortalException
SystemException

deletePhones

void deletePhones(long companyId,
                  String className,
                  long classPK)
                  throws SystemException
Throws:
SystemException

getPhones

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Phone> getPhones()
                      throws SystemException
Throws:
SystemException

getPhones

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Phone> getPhones(long companyId,
                                                               String className,
                                                               long classPK)
                      throws SystemException
Throws:
SystemException

updatePhone

Phone updatePhone(long phoneId,
                  String number,
                  String extension,
                  int typeId,
                  boolean primary)
                  throws PortalException,
                         SystemException
Throws:
PortalException
SystemException

Liferay 6.2-ce-ga5