Interface ContactLocalService
- All Superinterfaces:
BaseLocalService
,PersistedModelLocalService
- All Known Implementing Classes:
ContactLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddContact
(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) addContact
(Contact contact) Adds the contact to the database.createContact
(long contactId) Creates a new contact with the primary key.createPersistedModel
(Serializable primaryKeyObj) deleteContact
(long contactId) Deletes the contact with the primary key from the database.deleteContact
(Contact contact) Deletes the contact from the database.deletePersistedModel
(PersistedModel persistedModel) <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) <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.fetchContact
(long contactId) fetchContacts
(Set<Serializable> primaryKeys) getCompanyContacts
(long companyId, int start, int end) int
getCompanyContactsCount
(long companyId) 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) int
Returns the number of contacts.int
getContactsCount
(long classNameId, long classPK) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) 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) updateContact
(Contact contact) Updates the contact in the database or adds it if it does not yet exist.Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
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
@Indexable(type=REINDEX) 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
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- 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
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacePersistedModelLocalService
-
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
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
@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
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
@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 queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchContact
-
fetchContacts
@Transactional(propagation=SUPPORTS, readOnly=true) Map<Serializable,Contact> fetchContacts(Set<Serializable> primaryKeys) -
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery() -
getCompanyContacts
@Transactional(propagation=SUPPORTS, readOnly=true) List<Contact> getCompanyContacts(long companyId, int start, int end) -
getCompanyContactsCount
-
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
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
@Transactional(propagation=SUPPORTS, readOnly=true) List<Contact> getContacts(long classNameId, long classPK, int start, int end, OrderByComparator<Contact> orderByComparator) -
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 interfacePersistedModelLocalService
- 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
@Indexable(type=REINDEX) 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
-