Class ClassNameLocalServiceUtil
com.liferay.portal.service.impl.ClassNameLocalServiceImpl
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.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic ClassName
addClassName
(ClassName className) Adds the class name to the database.static ClassName
addClassName
(String value) static void
static ClassName
createClassName
(long classNameId) Creates a new class name with the primary key.static PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static ClassName
deleteClassName
(long classNameId) Deletes the class name with the primary key from the database.static ClassName
deleteClassName
(ClassName className) Deletes the class name from the database.static PersistedModel
deletePersistedModel
(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 DynamicQuery
static <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <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.static <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.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 ClassName
fetchByClassNameId
(long classNameId) static ClassName
fetchClassName
(long classNameId) static ClassName
fetchClassName
(String value) static ActionableDynamicQuery
static ClassName
getClassName
(long classNameId) Returns the class name with the primary key.static ClassName
getClassName
(String value) static long
getClassNameId
(Class<?> clazz) static long
getClassNameId
(String value) static Supplier<long[]>
getClassNameIdsSupplier
(String[] classNames) getClassNameIdSupplier
(String className) getClassNames
(int start, int end) Returns a range of all the class names.static int
Returns the number of class names.static String
Returns the OSGi service identifier.static PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static String
static ClassNameLocalService
static void
static void
setService
(ClassNameLocalService service) static ClassName
updateClassName
(ClassName className) Updates the class name in the database or adds it if it does not yet exist.
-
Constructor Details
-
ClassNameLocalServiceUtil
public ClassNameLocalServiceUtil()
-
-
Method Details
-
addClassName
Adds the class name to the database. Also notifies the appropriate model listeners.Important: Inspect ClassNameLocalServiceImpl 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:
className
- the class name- Returns:
- the class name that was added
-
addClassName
-
checkClassNames
public static void checkClassNames() -
createClassName
Creates a new class name with the primary key. Does not add the class name to the database.- Parameters:
classNameId
- the primary key for the new class name- Returns:
- the new class name
-
createPersistedModel
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - Throws:
PortalException
-
deleteClassName
Deletes the class name from the database. Also notifies the appropriate model listeners.Important: Inspect ClassNameLocalServiceImpl 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:
className
- the class name- Returns:
- the class name that was removed
-
deleteClassName
Deletes the class name with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect ClassNameLocalServiceImpl 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:
classNameId
- the primary key of the class name- Returns:
- the class name that was removed
- Throws:
PortalException
- if a class name 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(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dslQueryCount
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dynamicQuery
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
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.ClassNameModelImpl
.- 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
public static <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.ClassNameModelImpl
.- 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
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
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
-
fetchByClassNameId
-
fetchClassName
-
fetchClassName
-
getActionableDynamicQuery
-
getClassName
Returns the class name with the primary key.- Parameters:
classNameId
- the primary key of the class name- Returns:
- the class name
- Throws:
PortalException
- if a class name with the primary key could not be found
-
getClassName
-
getClassNameId
-
getClassNameId
-
getClassNameIdsSupplier
-
getClassNameIdSupplier
-
getClassNames
Returns a range of all the class names.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.ClassNameModelImpl
.- Parameters:
start
- the lower bound of the range of class namesend
- the upper bound of the range of class names (not inclusive)- Returns:
- the range of class names
-
getClassNamesCount
public static int getClassNamesCount()Returns the number of class names.- Returns:
- the number of class names
-
getIndexableActionableDynamicQuery
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
getRegistryName
-
invalidate
public static void invalidate() -
updateClassName
Updates the class name in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect ClassNameLocalServiceImpl 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:
className
- the class name- Returns:
- the class name that was updated
-
getService
-
setService
-