com.liferay.commerce.service

Interface CommerceOrderNoteLocalService

All Superinterfaces:

com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

All Known Implementing Classes:

CommerceOrderNoteLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface CommerceOrderNoteLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

Provides the local service interface for CommerceOrderNote. 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:

CommerceOrderNoteLocalServiceUtil

Generated:

Method Summary

Modifier and Type	Method and Description
CommerceOrderNote	addCommerceOrderNote(CommerceOrderNote commerceOrderNote) Adds the commerce order note to the database.
CommerceOrderNote	addCommerceOrderNote(long commerceOrderId, java.lang.String content, boolean restricted, com.liferay.portal.kernel.service.ServiceContext serviceContext)
CommerceOrderNote	addCommerceOrderNote(java.lang.String externalReferenceCode, long commerceOrderId, java.lang.String content, boolean restricted, com.liferay.portal.kernel.service.ServiceContext serviceContext)
CommerceOrderNote	addOrUpdateCommerceOrderNote(java.lang.String externalReferenceCode, long commerceOrderNoteId, long commerceOrderId, java.lang.String content, boolean restricted, com.liferay.portal.kernel.service.ServiceContext serviceContext)
CommerceOrderNote	createCommerceOrderNote(long commerceOrderNoteId) Creates a new commerce order note with the primary key.
com.liferay.portal.kernel.model.PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
CommerceOrderNote	deleteCommerceOrderNote(CommerceOrderNote commerceOrderNote) Deletes the commerce order note from the database.
CommerceOrderNote	deleteCommerceOrderNote(long commerceOrderNoteId) Deletes the commerce order note with the primary key from the database.
void	deleteCommerceOrderNotes(long commerceOrderId)
com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
<T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
int	dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.
CommerceOrderNote	fetchByExternalReferenceCode(java.lang.String externalReferenceCode, long companyId)
CommerceOrderNote	fetchCommerceOrderNote(long commerceOrderNoteId)
CommerceOrderNote	fetchCommerceOrderNoteByExternalReferenceCode(long companyId, java.lang.String externalReferenceCode) Returns the commerce order note with the matching external reference code and company.
CommerceOrderNote	fetchCommerceOrderNoteByReferenceCode(long companyId, java.lang.String externalReferenceCode) Deprecated. As of Cavanaugh (7.4.x), replaced by fetchCommerceOrderNoteByExternalReferenceCode(long, String)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
CommerceOrderNote	getCommerceOrderNote(long commerceOrderNoteId) Returns the commerce order note with the primary key.
CommerceOrderNote	getCommerceOrderNoteByExternalReferenceCode(long companyId, java.lang.String externalReferenceCode) Returns the commerce order note with the matching external reference code and company.
java.util.List<CommerceOrderNote>	getCommerceOrderNotes(int start, int end) Returns a range of all the commerce order notes.
java.util.List<CommerceOrderNote>	getCommerceOrderNotes(long commerceOrderId, boolean restricted)
java.util.List<CommerceOrderNote>	getCommerceOrderNotes(long commerceOrderId, int start, int end)
int	getCommerceOrderNotesCount() Returns the number of commerce order notes.
int	getCommerceOrderNotesCount(long commerceOrderId)
int	getCommerceOrderNotesCount(long commerceOrderId, boolean restricted)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
CommerceOrderNote	updateCommerceOrderNote(CommerceOrderNote commerceOrderNote) Updates the commerce order note in the database or adds it if it does not yet exist.
CommerceOrderNote	updateCommerceOrderNote(long commerceOrderNoteId, java.lang.String content, boolean restricted)
CommerceOrderNote	updateCommerceOrderNote(java.lang.String externalReferenceCode, long commerceOrderNoteId, java.lang.String content, boolean restricted)

Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService

getBasePersistence

Method Detail

addCommerceOrderNote

@Indexable(type=REINDEX)
CommerceOrderNote addCommerceOrderNote(CommerceOrderNote commerceOrderNote)

Adds the commerce order note to the database. Also notifies the appropriate model listeners.

Important: Inspect CommerceOrderNoteLocalServiceImpl 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:

commerceOrderNote - the commerce order note

Returns:

the commerce order note that was added

addCommerceOrderNote

CommerceOrderNote addCommerceOrderNote(long commerceOrderId,
                                       java.lang.String content,
                                       boolean restricted,
                                       com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addCommerceOrderNote

CommerceOrderNote addCommerceOrderNote(java.lang.String externalReferenceCode,
                                       long commerceOrderId,
                                       java.lang.String content,
                                       boolean restricted,
                                       com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addOrUpdateCommerceOrderNote

CommerceOrderNote addOrUpdateCommerceOrderNote(java.lang.String externalReferenceCode,
                                               long commerceOrderNoteId,
                                               long commerceOrderId,
                                               java.lang.String content,
                                               boolean restricted,
                                               com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

createCommerceOrderNote

@Transactional(enabled=false)
CommerceOrderNote createCommerceOrderNote(long commerceOrderNoteId)

Creates a new commerce order note with the primary key. Does not add the commerce order note to the database.

Parameters:

commerceOrderNoteId - the primary key for the new commerce order note

Returns:

the new commerce order note

createPersistedModel

com.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCommerceOrderNote

@Indexable(type=DELETE)
CommerceOrderNote deleteCommerceOrderNote(CommerceOrderNote commerceOrderNote)

Deletes the commerce order note from the database. Also notifies the appropriate model listeners.

Important: Inspect CommerceOrderNoteLocalServiceImpl 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:

commerceOrderNote - the commerce order note

Returns:

the commerce order note that was removed

deleteCommerceOrderNote

@Indexable(type=DELETE)
CommerceOrderNote deleteCommerceOrderNote(long commerceOrderNoteId)
                                                           throws com.liferay.portal.kernel.exception.PortalException

Deletes the commerce order note with the primary key from the database. Also notifies the appropriate model listeners.

Important: Inspect CommerceOrderNoteLocalServiceImpl 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:

commerceOrderNoteId - the primary key of the commerce order note

Returns:

the commerce order note that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException - if a commerce order note with the primary key could not be found

deleteCommerceOrderNotes

void deleteCommerceOrderNotes(long commerceOrderId)

deletePersistedModel

com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

dslQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

Specified by:

dslQuery in interface com.liferay.portal.kernel.service.PersistedModelLocalService

dslQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

Specified by:

dslQueryCount in interface com.liferay.portal.kernel.service.PersistedModelLocalService

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.commerce.model.impl.CommerceOrderNoteModelImpl.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                                                                      int start,
                                                                                                      int end,
                                                                                                      com.liferay.portal.kernel.util.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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.commerce.model.impl.CommerceOrderNoteModelImpl.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                                                          com.liferay.portal.kernel.dao.orm.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

fetchByExternalReferenceCode

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CommerceOrderNote fetchByExternalReferenceCode(java.lang.String externalReferenceCode,
                                                                                                                  long companyId)

fetchCommerceOrderNote

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CommerceOrderNote fetchCommerceOrderNote(long commerceOrderNoteId)

fetchCommerceOrderNoteByExternalReferenceCode

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CommerceOrderNote fetchCommerceOrderNoteByExternalReferenceCode(long companyId,
                                                                                                                                   java.lang.String externalReferenceCode)

Returns the commerce order note with the matching external reference code and company.

Parameters:

companyId - the primary key of the company

externalReferenceCode - the commerce order note's external reference code

Returns:

the matching commerce order note, or null if a matching commerce order note could not be found

fetchCommerceOrderNoteByReferenceCode

@Deprecated
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
CommerceOrderNote fetchCommerceOrderNoteByReferenceCode(long companyId,
                                                                                                                                        java.lang.String externalReferenceCode)

Deprecated. As of Cavanaugh (7.4.x), replaced by fetchCommerceOrderNoteByExternalReferenceCode(long, String)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getCommerceOrderNote

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CommerceOrderNote getCommerceOrderNote(long commerceOrderNoteId)
                                                                                                   throws com.liferay.portal.kernel.exception.PortalException

Returns the commerce order note with the primary key.

Parameters:

commerceOrderNoteId - the primary key of the commerce order note

Returns:

the commerce order note

Throws:

com.liferay.portal.kernel.exception.PortalException - if a commerce order note with the primary key could not be found

getCommerceOrderNoteByExternalReferenceCode

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CommerceOrderNote getCommerceOrderNoteByExternalReferenceCode(long companyId,
                                                                                                                                 java.lang.String externalReferenceCode)
                                                                                                                          throws com.liferay.portal.kernel.exception.PortalException

Returns the commerce order note with the matching external reference code and company.

Parameters:

companyId - the primary key of the company

externalReferenceCode - the commerce order note's external reference code

Returns:

the matching commerce order note

Throws:

com.liferay.portal.kernel.exception.PortalException - if a matching commerce order note could not be found

getCommerceOrderNotes

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CommerceOrderNote> getCommerceOrderNotes(int start,
                                                                                                                           int end)

Returns a range of all the commerce order notes.

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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.commerce.model.impl.CommerceOrderNoteModelImpl.

Parameters:

start - the lower bound of the range of commerce order notes

end - the upper bound of the range of commerce order notes (not inclusive)

Returns:

the range of commerce order notes

getCommerceOrderNotes

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CommerceOrderNote> getCommerceOrderNotes(long commerceOrderId,
                                                                                                                           boolean restricted)

getCommerceOrderNotes

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CommerceOrderNote> getCommerceOrderNotes(long commerceOrderId,
                                                                                                                           int start,
                                                                                                                           int end)

getCommerceOrderNotesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCommerceOrderNotesCount()

Returns the number of commerce order notes.

Returns:

the number of commerce order notes

getCommerceOrderNotesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCommerceOrderNotesCount(long commerceOrderId)

getCommerceOrderNotesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCommerceOrderNotesCount(long commerceOrderId,
                                                                                                  boolean restricted)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

updateCommerceOrderNote

@Indexable(type=REINDEX)
CommerceOrderNote updateCommerceOrderNote(CommerceOrderNote commerceOrderNote)

Updates the commerce order note in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Important: Inspect CommerceOrderNoteLocalServiceImpl 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:

commerceOrderNote - the commerce order note

Returns:

the commerce order note that was updated

updateCommerceOrderNote

CommerceOrderNote updateCommerceOrderNote(long commerceOrderNoteId,
                                          java.lang.String content,
                                          boolean restricted)
                                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateCommerceOrderNote

CommerceOrderNote updateCommerceOrderNote(java.lang.String externalReferenceCode,
                                          long commerceOrderNoteId,
                                          java.lang.String content,
                                          boolean restricted)
                                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException