com.liferay.dynamic.data.mapping.service

Class DDMStructureVersionLocalServiceUtil

java.lang.Object

com.liferay.dynamic.data.mapping.service.DDMStructureVersionLocalServiceUtil

public class DDMStructureVersionLocalServiceUtil
extends java.lang.Object

Provides the local service utility for DDMStructureVersion. This utility wraps com.liferay.dynamic.data.mapping.service.impl.DDMStructureVersionLocalServiceImpl 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:

DDMStructureVersionLocalService

Constructor Summary

Constructors

Constructor and Description
DDMStructureVersionLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static DDMStructureVersion	addDDMStructureVersion(DDMStructureVersion ddmStructureVersion) Adds the ddm structure version to the database.
static DDMStructureVersion	createDDMStructureVersion(long structureVersionId) Creates a new ddm structure version with the primary key.
static PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
static DDMStructureVersion	deleteDDMStructureVersion(DDMStructureVersion ddmStructureVersion) Deletes the ddm structure version from the database.
static DDMStructureVersion	deleteDDMStructureVersion(long structureVersionId) Deletes the ddm structure version with the primary key from the database.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static <T> T	dslQuery(DSLQuery dslQuery)
static DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> java.util.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> java.util.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 DDMStructureVersion	fetchDDMStructureVersion(long structureVersionId)
static ActionableDynamicQuery	getActionableDynamicQuery()
static DDMStructureVersion	getDDMStructureVersion(long structureVersionId) Returns the ddm structure version with the primary key.
static java.util.List<DDMStructureVersion>	getDDMStructureVersions(int start, int end) Returns a range of all the ddm structure versions.
static int	getDDMStructureVersionsCount() Returns the number of ddm structure versions.
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static DDMStructureVersion	getLatestStructureVersion(long structureId)
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static DDMStructureVersionLocalService	getService()
static DDMStructureVersion	getStructureVersion(long structureVersionId)
static DDMStructureVersion	getStructureVersion(long structureId, java.lang.String version)
static DDMForm	getStructureVersionDDMForm(DDMStructureVersion structureVersion)
static java.util.List<DDMStructureVersion>	getStructureVersions(long structureId)
static java.util.List<DDMStructureVersion>	getStructureVersions(long structureId, int start, int end, OrderByComparator<DDMStructureVersion> orderByComparator)
static int	getStructureVersionsCount(long structureId)
static DDMStructureVersion	updateDDMStructureVersion(DDMStructureVersion ddmStructureVersion) Updates the ddm structure version in the database or adds it if it does not yet exist.

Methods inherited from class java.lang.Object

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

Constructor Detail

DDMStructureVersionLocalServiceUtil

public DDMStructureVersionLocalServiceUtil()

Method Detail

addDDMStructureVersion

public static DDMStructureVersion addDDMStructureVersion(DDMStructureVersion ddmStructureVersion)

Adds the ddm structure version to the database. Also notifies the appropriate model listeners.

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

ddmStructureVersion - the ddm structure version

Returns:

the ddm structure version that was added

createDDMStructureVersion

public static DDMStructureVersion createDDMStructureVersion(long structureVersionId)

Creates a new ddm structure version with the primary key. Does not add the ddm structure version to the database.

Parameters:

structureVersionId - the primary key for the new ddm structure version

Returns:

the new ddm structure version

createPersistedModel

public static PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                                           throws PortalException

Throws:

PortalException

deleteDDMStructureVersion

public static DDMStructureVersion deleteDDMStructureVersion(DDMStructureVersion ddmStructureVersion)

Deletes the ddm structure version from the database. Also notifies the appropriate model listeners.

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

ddmStructureVersion - the ddm structure version

Returns:

the ddm structure version that was removed

deleteDDMStructureVersion

public static DDMStructureVersion deleteDDMStructureVersion(long structureVersionId)
                                                     throws PortalException

Deletes the ddm structure version with the primary key from the database. Also notifies the appropriate model listeners.

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

structureVersionId - the primary key of the ddm structure version

Returns:

the ddm structure version that was removed

Throws:

PortalException - if a ddm structure version 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(DSLQuery dslQuery)

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> java.util.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

public static <T> java.util.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 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.dynamic.data.mapping.model.impl.DDMStructureVersionModelImpl.

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(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 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.dynamic.data.mapping.model.impl.DDMStructureVersionModelImpl.

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(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(DynamicQuery dynamicQuery,
                                     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

fetchDDMStructureVersion

public static DDMStructureVersion fetchDDMStructureVersion(long structureVersionId)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getDDMStructureVersion

public static DDMStructureVersion getDDMStructureVersion(long structureVersionId)
                                                  throws PortalException

Returns the ddm structure version with the primary key.

Parameters:

structureVersionId - the primary key of the ddm structure version

Returns:

the ddm structure version

Throws:

PortalException - if a ddm structure version with the primary key could not be found

getDDMStructureVersions

public static java.util.List<DDMStructureVersion> getDDMStructureVersions(int start,
                                                                          int end)

Returns a range of all the ddm structure versions.

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.dynamic.data.mapping.model.impl.DDMStructureVersionModelImpl.

Parameters:

start - the lower bound of the range of ddm structure versions

end - the upper bound of the range of ddm structure versions (not inclusive)

Returns:

the range of ddm structure versions

getDDMStructureVersionsCount

public static int getDDMStructureVersionsCount()

Returns the number of ddm structure versions.

Returns:

the number of ddm structure versions

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getLatestStructureVersion

public static DDMStructureVersion getLatestStructureVersion(long structureId)
                                                     throws PortalException

Throws:

PortalException

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

getStructureVersion

public static DDMStructureVersion getStructureVersion(long structureVersionId)
                                               throws PortalException

Throws:

PortalException

getStructureVersion

public static DDMStructureVersion getStructureVersion(long structureId,
                                                      java.lang.String version)
                                               throws PortalException

Throws:

PortalException

getStructureVersionDDMForm

public static DDMForm getStructureVersionDDMForm(DDMStructureVersion structureVersion)
                                          throws PortalException

Throws:

PortalException

getStructureVersions

public static java.util.List<DDMStructureVersion> getStructureVersions(long structureId)

getStructureVersions

public static java.util.List<DDMStructureVersion> getStructureVersions(long structureId,
                                                                       int start,
                                                                       int end,
                                                                       OrderByComparator<DDMStructureVersion> orderByComparator)

getStructureVersionsCount

public static int getStructureVersionsCount(long structureId)

updateDDMStructureVersion

public static DDMStructureVersion updateDDMStructureVersion(DDMStructureVersion ddmStructureVersion)

Updates the ddm structure version in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

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

ddmStructureVersion - the ddm structure version

Returns:

the ddm structure version that was updated

getService

public static DDMStructureVersionLocalService getService()