com.liferay.commerce.service

Class CommerceOrderTypeLocalServiceUtil

java.lang.Object

com.liferay.commerce.service.CommerceOrderTypeLocalServiceUtil

public class CommerceOrderTypeLocalServiceUtil
extends java.lang.Object

Provides the local service utility for CommerceOrderType. This utility wraps com.liferay.commerce.service.impl.CommerceOrderTypeLocalServiceImpl 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.

See Also:

CommerceOrderTypeLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
CommerceOrderTypeLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static CommerceOrderType	addCommerceOrderType(CommerceOrderType commerceOrderType) Adds the commerce order type to the database.
static CommerceOrderType	addCommerceOrderType(java.lang.String externalReferenceCode, long userId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, boolean active, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int displayOrder, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static void	checkCommerceOrderTypes()
static CommerceOrderType	createCommerceOrderType(long commerceOrderTypeId) Creates a new commerce order type with the primary key.
static com.liferay.portal.kernel.model.PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
static CommerceOrderType	deleteCommerceOrderType(CommerceOrderType commerceOrderType) Deletes the commerce order type from the database.
static CommerceOrderType	deleteCommerceOrderType(long commerceOrderTypeId) Deletes the commerce order type with the primary key from the database.
static com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.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 com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
static <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.
static <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.
static <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.
static long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static 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.
static CommerceOrderType	fetchByExternalReferenceCode(java.lang.String externalReferenceCode, long companyId)
static CommerceOrderType	fetchCommerceOrderType(long commerceOrderTypeId)
static CommerceOrderType	fetchCommerceOrderTypeByExternalReferenceCode(long companyId, java.lang.String externalReferenceCode) Returns the commerce order type with the matching external reference code and company.
static CommerceOrderType	fetchCommerceOrderTypeByReferenceCode(long companyId, java.lang.String externalReferenceCode) Deprecated. As of Cavanaugh (7.4.x), replaced by fetchCommerceOrderTypeByExternalReferenceCode(long, String)
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
static CommerceOrderType	getCommerceOrderType(long commerceOrderTypeId) Returns the commerce order type with the primary key.
static CommerceOrderType	getCommerceOrderTypeByExternalReferenceCode(long companyId, java.lang.String externalReferenceCode) Returns the commerce order type with the matching external reference code and company.
static java.util.List<CommerceOrderType>	getCommerceOrderTypes(int start, int end) Returns a range of all the commerce order types.
static java.util.List<CommerceOrderType>	getCommerceOrderTypes(long companyId, java.lang.String className, long classPK, boolean active, int start, int end)
static int	getCommerceOrderTypesCount() Returns the number of commerce order types.
static int	getCommerceOrderTypesCount(long companyId, boolean active)
static int	getCommerceOrderTypesCount(long companyId, java.lang.String className, long classPK, boolean active)
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static CommerceOrderTypeLocalService	getService()
static CommerceOrderType	updateCommerceOrderType(CommerceOrderType commerceOrderType) Updates the commerce order type in the database or adds it if it does not yet exist.
static CommerceOrderType	updateCommerceOrderType(java.lang.String externalReferenceCode, long userId, long commerceOrderTypeId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, boolean active, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int displayOrder, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static CommerceOrderType	updateCommerceOrderTypeExternalReferenceCode(java.lang.String externalReferenceCode, long commerceOrderTypeId)
static CommerceOrderType	updateStatus(long userId, long commerceOrderTypeId, int status, com.liferay.portal.kernel.service.ServiceContext serviceContext, java.util.Map<java.lang.String,java.io.Serializable> workflowContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommerceOrderTypeLocalServiceUtil

public CommerceOrderTypeLocalServiceUtil()

Method Detail

addCommerceOrderType

public static CommerceOrderType addCommerceOrderType(CommerceOrderType commerceOrderType)

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

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

commerceOrderType - the commerce order type

Returns:

the commerce order type that was added

addCommerceOrderType

public static CommerceOrderType addCommerceOrderType(java.lang.String externalReferenceCode,
                                                     long userId,
                                                     java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                                     java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                                     boolean active,
                                                     int displayDateMonth,
                                                     int displayDateDay,
                                                     int displayDateYear,
                                                     int displayDateHour,
                                                     int displayDateMinute,
                                                     int displayOrder,
                                                     int expirationDateMonth,
                                                     int expirationDateDay,
                                                     int expirationDateYear,
                                                     int expirationDateHour,
                                                     int expirationDateMinute,
                                                     boolean neverExpire,
                                                     com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                              throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

checkCommerceOrderTypes

public static void checkCommerceOrderTypes()
                                    throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

createCommerceOrderType

public static CommerceOrderType createCommerceOrderType(long commerceOrderTypeId)

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

Parameters:

commerceOrderTypeId - the primary key for the new commerce order type

Returns:

the new commerce order type

createPersistedModel

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

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCommerceOrderType

public static CommerceOrderType deleteCommerceOrderType(CommerceOrderType commerceOrderType)
                                                 throws com.liferay.portal.kernel.exception.PortalException

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

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

commerceOrderType - the commerce order type

Returns:

the commerce order type that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCommerceOrderType

public static CommerceOrderType deleteCommerceOrderType(long commerceOrderTypeId)
                                                 throws com.liferay.portal.kernel.exception.PortalException

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

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

commerceOrderTypeId - the primary key of the commerce order type

Returns:

the commerce order type that was removed

Throws:

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

deletePersistedModel

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

Throws:

com.liferay.portal.kernel.exception.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

public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

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

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

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

public static CommerceOrderType fetchByExternalReferenceCode(java.lang.String externalReferenceCode,
                                                             long companyId)

fetchCommerceOrderType

public static CommerceOrderType fetchCommerceOrderType(long commerceOrderTypeId)

fetchCommerceOrderTypeByExternalReferenceCode

public static CommerceOrderType fetchCommerceOrderTypeByExternalReferenceCode(long companyId,
                                                                              java.lang.String externalReferenceCode)

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

Parameters:

companyId - the primary key of the company

externalReferenceCode - the commerce order type's external reference code

Returns:

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

fetchCommerceOrderTypeByReferenceCode

@Deprecated
public static CommerceOrderType fetchCommerceOrderTypeByReferenceCode(long companyId,
                                                                                  java.lang.String externalReferenceCode)

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

getActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getCommerceOrderType

public static CommerceOrderType getCommerceOrderType(long commerceOrderTypeId)
                                              throws com.liferay.portal.kernel.exception.PortalException

Returns the commerce order type with the primary key.

Parameters:

commerceOrderTypeId - the primary key of the commerce order type

Returns:

the commerce order type

Throws:

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

getCommerceOrderTypeByExternalReferenceCode

public static CommerceOrderType getCommerceOrderTypeByExternalReferenceCode(long companyId,
                                                                            java.lang.String externalReferenceCode)
                                                                     throws com.liferay.portal.kernel.exception.PortalException

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

Parameters:

companyId - the primary key of the company

externalReferenceCode - the commerce order type's external reference code

Returns:

the matching commerce order type

Throws:

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

getCommerceOrderTypes

public static java.util.List<CommerceOrderType> getCommerceOrderTypes(int start,
                                                                      int end)

Returns a range of all the commerce order types.

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.CommerceOrderTypeModelImpl.

Parameters:

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

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

Returns:

the range of commerce order types

getCommerceOrderTypes

public static java.util.List<CommerceOrderType> getCommerceOrderTypes(long companyId,
                                                                      java.lang.String className,
                                                                      long classPK,
                                                                      boolean active,
                                                                      int start,
                                                                      int end)
                                                               throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getCommerceOrderTypesCount

public static int getCommerceOrderTypesCount()

Returns the number of commerce order types.

Returns:

the number of commerce order types

getCommerceOrderTypesCount

public static int getCommerceOrderTypesCount(long companyId,
                                             boolean active)

getCommerceOrderTypesCount

public static int getCommerceOrderTypesCount(long companyId,
                                             java.lang.String className,
                                             long classPK,
                                             boolean active)
                                      throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getIndexableActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

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

Throws:

com.liferay.portal.kernel.exception.PortalException

updateCommerceOrderType

public static CommerceOrderType updateCommerceOrderType(CommerceOrderType commerceOrderType)

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

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

commerceOrderType - the commerce order type

Returns:

the commerce order type that was updated

updateCommerceOrderType

public static CommerceOrderType updateCommerceOrderType(java.lang.String externalReferenceCode,
                                                        long userId,
                                                        long commerceOrderTypeId,
                                                        java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                                        java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                                        boolean active,
                                                        int displayDateMonth,
                                                        int displayDateDay,
                                                        int displayDateYear,
                                                        int displayDateHour,
                                                        int displayDateMinute,
                                                        int displayOrder,
                                                        int expirationDateMonth,
                                                        int expirationDateDay,
                                                        int expirationDateYear,
                                                        int expirationDateHour,
                                                        int expirationDateMinute,
                                                        boolean neverExpire,
                                                        com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateCommerceOrderTypeExternalReferenceCode

public static CommerceOrderType updateCommerceOrderTypeExternalReferenceCode(java.lang.String externalReferenceCode,
                                                                             long commerceOrderTypeId)
                                                                      throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateStatus

public static CommerceOrderType updateStatus(long userId,
                                             long commerceOrderTypeId,
                                             int status,
                                             com.liferay.portal.kernel.service.ServiceContext serviceContext,
                                             java.util.Map<java.lang.String,java.io.Serializable> workflowContext)
                                      throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getService

public static CommerceOrderTypeLocalService getService()