com.liferay.portal.kernel.service

Class ContactLocalServiceUtil

Object

com.liferay.portal.kernel.service.ContactLocalServiceUtil

@ProviderType
public class ContactLocalServiceUtil
extends Object

Provides the local service utility for Contact. This utility wraps ContactLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. 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:

ContactLocalService, ContactLocalServiceBaseImpl, ContactLocalServiceImpl

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
ContactLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static Contact	addContact(Contact contact) Adds the contact to the database.
static 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)
static Contact	createContact(long contactId) Creates a new contact with the primary key.
static Contact	deleteContact(Contact contact) Deletes the contact from the database.
static Contact	deleteContact(long contactId) Deletes the contact with the primary key from the database.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static DynamicQuery	dynamicQuery()
static <T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <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.
static <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.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static Contact	fetchContact(long contactId)
static ActionableDynamicQuery	getActionableDynamicQuery()
static List<Contact>	getCompanyContacts(long companyId, int start, int end)
static int	getCompanyContactsCount(long companyId)
static Contact	getContact(long contactId) Returns the contact with the primary key.
static List<Contact>	getContacts(int start, int end) Returns a range of all the contacts.
static List<Contact>	getContacts(long classNameId, long classPK, int start, int end, OrderByComparator<Contact> orderByComparator)
static int	getContactsCount() Returns the number of contacts.
static int	getContactsCount(long classNameId, long classPK)
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static ContactLocalService	getService()
static Contact	updateContact(Contact contact) Updates the contact in the database or adds it if it does not yet exist.
static 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)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContactLocalServiceUtil

public ContactLocalServiceUtil()

Method Detail

addContact

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

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

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

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

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

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

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

public static Contact fetchContact(long contactId)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getCompanyContacts

public static List<Contact> getCompanyContacts(long companyId,
                                               int start,
                                               int end)

getCompanyContactsCount

public static int getCompanyContactsCount(long companyId)

getContact

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

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

public static List<Contact> getContacts(long classNameId,
                                        long classPK,
                                        int start,
                                        int end,
                                        OrderByComparator<Contact> orderByComparator)

getContactsCount

public static int getContactsCount()

Returns the number of contacts.

Returns:

the number of contacts

getContactsCount

public static int getContactsCount(long classNameId,
                                   long classPK)

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

updateContact

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

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

getService

public static ContactLocalService getService()