com.liferay.portal.kernel.service

Interface ContactLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

ContactLocalServiceWrapper

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

Provides the local service interface for Contact. 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:

ContactLocalServiceUtil, ContactLocalServiceBaseImpl, ContactLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
Contact	addContact(Contact contact) Adds the contact to the database.
Contact	addContact(long userId, String className, long classPK, String emailAddress, String firstName, String middleName, String lastName, long prefixId, long suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String smsSn, String facebookSn, String jabberSn, String skypeSn, String twitterSn, String jobTitle)
Contact	createContact(long contactId) Creates a new contact with the primary key.
Contact	deleteContact(Contact contact) Deletes the contact from the database.
Contact	deleteContact(long contactId) Deletes the contact 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.
Contact	fetchContact(long contactId)
ActionableDynamicQuery	getActionableDynamicQuery()
List<Contact>	getCompanyContacts(long companyId, int start, int end)
int	getCompanyContactsCount(long companyId)
Contact	getContact(long contactId) Returns the contact with the primary key.
List<Contact>	getContacts(int start, int end) Returns a range of all the contacts.
List<Contact>	getContacts(long classNameId, long classPK, int start, int end, OrderByComparator<Contact> orderByComparator)
int	getContactsCount() Returns the number of contacts.
int	getContactsCount(long classNameId, long classPK)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
Contact	updateContact(Contact contact) Updates the contact in the database or adds it if it does not yet exist.
Contact	updateContact(long contactId, String emailAddress, String firstName, String middleName, String lastName, long prefixId, long suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String smsSn, String facebookSn, String jabberSn, String skypeSn, String twitterSn, String jobTitle)

Method Detail

addContact

@Indexable(type=REINDEX)
Contact addContact(Contact contact)

Adds the contact to the database. Also notifies the appropriate model listeners.

Parameters:

contact - the contact

Returns:

the contact that was added

addContact

@Indexable(type=REINDEX)
Contact addContact(long userId,
                                            String className,
                                            long classPK,
                                            String emailAddress,
                                            String firstName,
                                            String middleName,
                                            String lastName,
                                            long prefixId,
                                            long suffixId,
                                            boolean male,
                                            int birthdayMonth,
                                            int birthdayDay,
                                            int birthdayYear,
                                            String smsSn,
                                            String facebookSn,
                                            String jabberSn,
                                            String skypeSn,
                                            String twitterSn,
                                            String jobTitle)
                                     throws PortalException

Throws:

PortalException

createContact

@Transactional(enabled=false)
Contact createContact(long contactId)

Creates a new contact with the primary key. Does not add the contact to the database.

Parameters:

contactId - the primary key for the new contact

Returns:

the new contact

deleteContact

@Indexable(type=DELETE)
Contact deleteContact(Contact contact)

Deletes the contact from the database. Also notifies the appropriate model listeners.

Parameters:

contact - the contact

Returns:

the contact that was removed

deleteContact

@Indexable(type=DELETE)
Contact deleteContact(long contactId)
                                       throws PortalException

Deletes the contact with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

contactId - the primary key of the contact

Returns:

the contact that was removed

Throws:

PortalException - if a contact 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 ContactModelImpl. 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 ContactModelImpl. 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

fetchContact

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Contact fetchContact(long contactId)

getActionableDynamicQuery

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

getCompanyContacts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Contact> getCompanyContacts(long companyId,
                                                                                                    int start,
                                                                                                    int end)

getCompanyContactsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCompanyContactsCount(long companyId)

getContact

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Contact getContact(long contactId)
                                                                               throws PortalException

Returns the contact with the primary key.

Parameters:

contactId - the primary key of the contact

Returns:

the contact

Throws:

PortalException - if a contact with the primary key could not be found

getContacts

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

Returns a range of all the contacts.

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 ContactModelImpl. 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 contacts

end - the upper bound of the range of contacts (not inclusive)

Returns:

the range of contacts

getContacts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Contact> getContacts(long classNameId,
                                                                                             long classPK,
                                                                                             int start,
                                                                                             int end,
                                                                                             OrderByComparator<Contact> orderByComparator)

getContactsCount

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

Returns the number of contacts.

Returns:

the number of contacts

getContactsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getContactsCount(long classNameId,
                                                                                        long classPK)

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

updateContact

@Indexable(type=REINDEX)
Contact updateContact(Contact contact)

Updates the contact in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

contact - the contact

Returns:

the contact that was updated

updateContact

@Indexable(type=REINDEX)
Contact updateContact(long contactId,
                                               String emailAddress,
                                               String firstName,
                                               String middleName,
                                               String lastName,
                                               long prefixId,
                                               long suffixId,
                                               boolean male,
                                               int birthdayMonth,
                                               int birthdayDay,
                                               int birthdayYear,
                                               String smsSn,
                                               String facebookSn,
                                               String jabberSn,
                                               String skypeSn,
                                               String twitterSn,
                                               String jobTitle)
                                        throws PortalException

Throws:

PortalException