Class ContactLocalServiceUtil
com.liferay.portal.service.impl.ContactLocalServiceImpl
and
is an 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:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic Contact
addContact
(long userId, String className, long classPK, String emailAddress, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String smsSn, String facebookSn, String jabberSn, String skypeSn, String twitterSn, String jobTitle) static Contact
addContact
(Contact contact) Adds the contact to the database.static Contact
createContact
(long contactId) Creates a new contact with the primary key.static PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static Contact
deleteContact
(long contactId) Deletes the contact with the primary key from the database.static Contact
deleteContact
(Contact contact) Deletes the contact from the database.static PersistedModel
deletePersistedModel
(PersistedModel persistedModel) static <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static 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 Map<Serializable,
Contact> fetchContacts
(Set<Serializable> primaryKeys) static ActionableDynamicQuery
getCompanyContacts
(long companyId, int start, int end) static int
getCompanyContactsCount
(long companyId) static Contact
getContact
(long contactId) Returns the contact with the primary key.getContacts
(int start, int end) Returns a range of all the contacts.getContacts
(long classNameId, long classPK, int start, int end, OrderByComparator<Contact> orderByComparator) static int
Returns the number of contacts.static int
getContactsCount
(long classNameId, long classPK) static String
Returns the OSGi service identifier.static PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static ContactLocalService
static void
setService
(ContactLocalService service) static Contact
updateContact
(long contactId, String emailAddress, String firstName, String middleName, String lastName, long prefixListTypeId, long suffixListTypeId, boolean male, int birthdayMonth, int birthdayDay, int birthdayYear, String smsSn, String facebookSn, String jabberSn, String skypeSn, String twitterSn, String jobTitle) static Contact
updateContact
(Contact contact) Updates the contact in the database or adds it if it does not yet exist.
-
Constructor Details
-
ContactLocalServiceUtil
public ContactLocalServiceUtil()
-
-
Method Details
-
addContact
Adds the contact to the database. Also notifies the appropriate model listeners.Important: Inspect ContactLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- 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 prefixListTypeId, long suffixListTypeId, 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
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
-
createPersistedModel
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - Throws:
PortalException
-
deleteContact
Deletes the contact from the database. Also notifies the appropriate model listeners.Important: Inspect ContactLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
contact
- the contact- Returns:
- the contact that was removed
-
deleteContact
Deletes the contact with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect ContactLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- 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
-
dslQuery
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dslQueryCount
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dynamicQuery
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.ContactModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.ContactModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchContact
-
fetchContacts
-
getActionableDynamicQuery
-
getCompanyContacts
-
getCompanyContactsCount
public static int getCompanyContactsCount(long companyId) -
getContact
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
Returns a range of all the contacts.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.ContactModelImpl
.- Parameters:
start
- the lower bound of the range of contactsend
- 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
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
updateContact
Updates the contact in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect ContactLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- 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 prefixListTypeId, long suffixListTypeId, 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
-
setService
-