Liferay 6.2-ce-ga5

com.liferay.portal.service
Class ContactLocalServiceUtil

java.lang.Object
  extended by com.liferay.portal.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.

See Also:
ContactLocalService, ContactLocalServiceBaseImpl, ContactLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
ContactLocalServiceUtil()
           
 
Method Summary
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, int prefixId, int suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String smsSn, String aimSn, String facebookSn, String icqSn, String jabberSn, String msnSn, String mySpaceSn, String skypeSn, String twitterSn, String ymSn, 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 DynamicQuery dynamicQuery()
           
static List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static 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.
static long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
static Contact fetchContact(long contactId)
           
static String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
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 orderByComparator)
           
static int getContactsCount()
          Returns the number of contacts.
static int getContactsCount(long classNameId, long classPK)
           
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static ContactLocalService getService()
           
static void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setService(ContactLocalService service)
          Deprecated. As of 6.2.0
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, int prefixId, int suffixId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String smsSn, String aimSn, String facebookSn, String icqSn, String jabberSn, String msnSn, String mySpaceSn, String skypeSn, String twitterSn, String ymSn, String jobTitle)
           
 
Methods inherited from class java.lang.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)
                          throws SystemException
Adds the contact to the database. Also notifies the appropriate model listeners.

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

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(long contactId)
                             throws PortalException,
                                    SystemException
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
SystemException - if a system exception occurred

deleteContact

public static Contact deleteContact(Contact contact)
                             throws SystemException
Deletes the contact from the database. Also notifies the appropriate model listeners.

Parameters:
contact - the contact
Returns:
the contact that was removed
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

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

public static 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 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
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static 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 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
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

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

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

fetchContact

public static Contact fetchContact(long contactId)
                            throws SystemException
Throws:
SystemException

getContact

public static Contact getContact(long contactId)
                          throws PortalException,
                                 SystemException
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
SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException
Throws:
PortalException
SystemException

getContacts

public static List<Contact> getContacts(int start,
                                        int end)
                                 throws SystemException
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
Throws:
SystemException - if a system exception occurred

getContactsCount

public static int getContactsCount()
                            throws SystemException
Returns the number of contacts.

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

updateContact

public static Contact updateContact(Contact contact)
                             throws SystemException
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
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addContact

public static Contact addContact(long userId,
                                 String className,
                                 long classPK,
                                 String emailAddress,
                                 String firstName,
                                 String middleName,
                                 String lastName,
                                 int prefixId,
                                 int suffixId,
                                 boolean male,
                                 int birthdayMonth,
                                 int birthdayDay,
                                 int birthdayYear,
                                 String smsSn,
                                 String aimSn,
                                 String facebookSn,
                                 String icqSn,
                                 String jabberSn,
                                 String msnSn,
                                 String mySpaceSn,
                                 String skypeSn,
                                 String twitterSn,
                                 String ymSn,
                                 String jobTitle)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

getContacts

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

getContactsCount

public static int getContactsCount(long classNameId,
                                   long classPK)
                            throws SystemException
Throws:
SystemException

updateContact

public static Contact updateContact(long contactId,
                                    String emailAddress,
                                    String firstName,
                                    String middleName,
                                    String lastName,
                                    int prefixId,
                                    int suffixId,
                                    boolean male,
                                    int birthdayMonth,
                                    int birthdayDay,
                                    int birthdayYear,
                                    String smsSn,
                                    String aimSn,
                                    String facebookSn,
                                    String icqSn,
                                    String jabberSn,
                                    String msnSn,
                                    String mySpaceSn,
                                    String skypeSn,
                                    String twitterSn,
                                    String ymSn,
                                    String jobTitle)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

getService

public static ContactLocalService getService()

setService

public void setService(ContactLocalService service)
Deprecated. As of 6.2.0


Liferay 6.2-ce-ga5