|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@ProviderType @Transactional(isolation=PORTAL, rollbackFor={PortalException.class,SystemException.class}) public interface EmailAddressLocalService
Provides the local service interface for EmailAddress. 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.
EmailAddressLocalServiceUtil
,
EmailAddressLocalServiceBaseImpl
,
com.liferay.portal.service.impl.EmailAddressLocalServiceImpl
Method Summary | |
---|---|
EmailAddress |
addEmailAddress(EmailAddress emailAddress)
Adds the email address to the database. |
EmailAddress |
addEmailAddress(long userId,
String className,
long classPK,
String address,
int typeId,
boolean primary)
Deprecated. As of 6.2.0, replaced by addEmailAddress(long,
String, long, String, int, boolean, ServiceContext) |
EmailAddress |
addEmailAddress(long userId,
String className,
long classPK,
String address,
int typeId,
boolean primary,
ServiceContext serviceContext)
|
EmailAddress |
createEmailAddress(long emailAddressId)
Creates a new email address with the primary key. |
EmailAddress |
deleteEmailAddress(EmailAddress emailAddress)
Deletes the email address from the database. |
EmailAddress |
deleteEmailAddress(long emailAddressId)
Deletes the email address with the primary key from the database. |
void |
deleteEmailAddresses(long companyId,
String className,
long classPK)
|
DynamicQuery |
dynamicQuery()
|
List |
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
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. |
long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows that match the dynamic query. |
long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows that match the dynamic query. |
EmailAddress |
fetchEmailAddress(long emailAddressId)
|
EmailAddress |
fetchEmailAddressByUuidAndCompanyId(String uuid,
long companyId)
Returns the email address with the matching UUID and company. |
String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
EmailAddress |
getEmailAddress(long emailAddressId)
Returns the email address with the primary key. |
EmailAddress |
getEmailAddressByUuidAndCompanyId(String uuid,
long companyId)
Returns the email address with the matching UUID and company. |
List<EmailAddress> |
getEmailAddresses()
|
List<EmailAddress> |
getEmailAddresses(int start,
int end)
Returns a range of all the email addresses. |
List<EmailAddress> |
getEmailAddresses(long companyId,
String className,
long classPK)
|
int |
getEmailAddressesCount()
Returns the number of email addresses. |
PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
EmailAddress |
updateEmailAddress(EmailAddress emailAddress)
Updates the email address in the database or adds it if it does not yet exist. |
EmailAddress |
updateEmailAddress(long emailAddressId,
String address,
int typeId,
boolean primary)
|
Method Detail |
---|
@Indexable(type=REINDEX) EmailAddress addEmailAddress(EmailAddress emailAddress) throws SystemException
emailAddress
- the email address
SystemException
- if a system exception occurredEmailAddress createEmailAddress(long emailAddressId)
emailAddressId
- the primary key for the new email address
@Indexable(type=DELETE) EmailAddress deleteEmailAddress(long emailAddressId) throws PortalException, SystemException
emailAddressId
- the primary key of the email address
PortalException
- if a email address with the primary key could not be found
SystemException
- if a system exception occurred@Indexable(type=DELETE) EmailAddress deleteEmailAddress(EmailAddress emailAddress) throws SystemException
emailAddress
- the email address
SystemException
- if a system exception occurredDynamicQuery dynamicQuery()
List dynamicQuery(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query
SystemException
- if a system exception occurredList dynamicQuery(DynamicQuery dynamicQuery, int start, int end) throws SystemException
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 EmailAddressModelImpl
. 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.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)
SystemException
- if a system exception occurredList dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) throws SystemException
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 EmailAddressModelImpl
. 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.
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 (optionally null
)
SystemException
- if a system exception occurredlong dynamicQueryCount(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query
SystemException
- if a system exception occurredlong dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) throws SystemException
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) EmailAddress fetchEmailAddress(long emailAddressId) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) EmailAddress fetchEmailAddressByUuidAndCompanyId(String uuid, long companyId) throws SystemException
uuid
- the email address's UUIDcompanyId
- the primary key of the company
null
if a matching email address could not be found
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) EmailAddress getEmailAddress(long emailAddressId) throws PortalException, SystemException
emailAddressId
- the primary key of the email address
PortalException
- if a email address with the primary key could not be found
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException, SystemException
getPersistedModel
in interface PersistedModelLocalService
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) EmailAddress getEmailAddressByUuidAndCompanyId(String uuid, long companyId) throws PortalException, SystemException
uuid
- the email address's UUIDcompanyId
- the primary key of the company
PortalException
- if a matching email address could not be found
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<EmailAddress> getEmailAddresses(int start, int end) throws SystemException
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 EmailAddressModelImpl
. 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.
start
- the lower bound of the range of email addressesend
- the upper bound of the range of email addresses (not inclusive)
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getEmailAddressesCount() throws SystemException
SystemException
- if a system exception occurred@Indexable(type=REINDEX) EmailAddress updateEmailAddress(EmailAddress emailAddress) throws SystemException
emailAddress
- the email address
SystemException
- if a system exception occurredString getBeanIdentifier()
void setBeanIdentifier(String beanIdentifier)
beanIdentifier
- the Spring bean ID for this beanEmailAddress addEmailAddress(long userId, String className, long classPK, String address, int typeId, boolean primary) throws PortalException, SystemException
addEmailAddress(long,
String, long, String, int, boolean, ServiceContext)
PortalException
SystemException
EmailAddress addEmailAddress(long userId, String className, long classPK, String address, int typeId, boolean primary, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
void deleteEmailAddresses(long companyId, String className, long classPK) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<EmailAddress> getEmailAddresses() throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<EmailAddress> getEmailAddresses(long companyId, String className, long classPK) throws SystemException
SystemException
EmailAddress updateEmailAddress(long emailAddressId, String address, int typeId, boolean primary) throws PortalException, SystemException
PortalException
SystemException
|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |