@ProviderType
public class LayoutPrototypeLocalServiceUtil
extends Object
LayoutPrototypeLocalServiceImpl
and is the
primary 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.LayoutPrototypeLocalService
,
LayoutPrototypeLocalServiceBaseImpl
,
LayoutPrototypeLocalServiceImpl
Constructor and Description |
---|
LayoutPrototypeLocalServiceUtil() |
Modifier and Type | Method and Description |
---|---|
static LayoutPrototype |
addLayoutPrototype(LayoutPrototype layoutPrototype)
Adds the layout prototype to the database.
|
static LayoutPrototype |
addLayoutPrototype(long userId,
long companyId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
boolean active,
ServiceContext serviceContext) |
static LayoutPrototype |
addLayoutPrototype(long userId,
long companyId,
Map<Locale,String> nameMap,
String description,
boolean active,
ServiceContext serviceContext)
Deprecated.
As of Wilberforce (7.0.x), replaced by
addLayoutPrototype(long, long, Map, Map, boolean,
ServiceContext) |
static LayoutPrototype |
createLayoutPrototype(long layoutPrototypeId)
Creates a new layout prototype with the primary key.
|
static LayoutPrototype |
deleteLayoutPrototype(LayoutPrototype layoutPrototype)
Deletes the layout prototype from the database.
|
static LayoutPrototype |
deleteLayoutPrototype(long layoutPrototypeId)
Deletes the layout prototype with the primary key from the database.
|
static void |
deleteNondefaultLayoutPrototypes(long companyId) |
static PersistedModel |
deletePersistedModel(PersistedModel persistedModel) |
static DynamicQuery |
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 LayoutPrototype |
fetchLayoutPrototype(long layoutPrototypeId) |
static LayoutPrototype |
fetchLayoutPrototypeByUuidAndCompanyId(String uuid,
long companyId)
Returns the layout prototype with the matching UUID and company.
|
static ActionableDynamicQuery |
getActionableDynamicQuery() |
static ExportActionableDynamicQuery |
getExportActionableDynamicQuery(PortletDataContext portletDataContext) |
static IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
static LayoutPrototype |
getLayoutPrototype(long layoutPrototypeId)
Returns the layout prototype with the primary key.
|
static LayoutPrototype |
getLayoutPrototypeByUuidAndCompanyId(String uuid,
long companyId)
Returns the layout prototype with the matching UUID and company.
|
static List<LayoutPrototype> |
getLayoutPrototypes(int start,
int end)
Returns a range of all the layout prototypes.
|
static int |
getLayoutPrototypesCount()
Returns the number of layout prototypes.
|
static String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static PersistedModel |
getPersistedModel(Serializable primaryKeyObj) |
static LayoutPrototypeLocalService |
getService() |
static List<LayoutPrototype> |
search(long companyId,
Boolean active,
int start,
int end,
OrderByComparator<LayoutPrototype> obc) |
static int |
searchCount(long companyId,
Boolean active) |
static LayoutPrototype |
updateLayoutPrototype(LayoutPrototype layoutPrototype)
Updates the layout prototype in the database or adds it if it does not yet exist.
|
static LayoutPrototype |
updateLayoutPrototype(long layoutPrototypeId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
boolean active,
ServiceContext serviceContext) |
static LayoutPrototype |
updateLayoutPrototype(long layoutPrototypeId,
Map<Locale,String> nameMap,
String description,
boolean active,
ServiceContext serviceContext)
Deprecated.
As of Wilberforce (7.0.x), replaced by
updateLayoutPrototype(long, Map, Map, boolean,
ServiceContext) |
public static LayoutPrototype addLayoutPrototype(LayoutPrototype layoutPrototype)
layoutPrototype
- the layout prototypepublic static LayoutPrototype addLayoutPrototype(long userId, long companyId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, boolean active, ServiceContext serviceContext) throws PortalException
PortalException
@Deprecated public static LayoutPrototype addLayoutPrototype(long userId, long companyId, Map<Locale,String> nameMap, String description, boolean active, ServiceContext serviceContext) throws PortalException
addLayoutPrototype(long, long, Map, Map, boolean,
ServiceContext)
PortalException
public static LayoutPrototype createLayoutPrototype(long layoutPrototypeId)
layoutPrototypeId
- the primary key for the new layout prototypepublic static LayoutPrototype deleteLayoutPrototype(LayoutPrototype layoutPrototype) throws PortalException
layoutPrototype
- the layout prototypePortalException
public static LayoutPrototype deleteLayoutPrototype(long layoutPrototypeId) throws PortalException
layoutPrototypeId
- the primary key of the layout prototypePortalException
- if a layout prototype with the primary key could not be foundpublic static void deleteNondefaultLayoutPrototypes(long companyId) throws PortalException
PortalException
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
PortalException
public static DynamicQuery dynamicQuery()
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
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 LayoutPrototypeModelImpl
. 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)public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)
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 LayoutPrototypeModelImpl
. 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
)public static long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the querypublic static LayoutPrototype fetchLayoutPrototype(long layoutPrototypeId)
public static LayoutPrototype fetchLayoutPrototypeByUuidAndCompanyId(String uuid, long companyId)
uuid
- the layout prototype's UUIDcompanyId
- the primary key of the companynull
if a matching layout prototype could not be foundpublic static ActionableDynamicQuery getActionableDynamicQuery()
public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static LayoutPrototype getLayoutPrototype(long layoutPrototypeId) throws PortalException
layoutPrototypeId
- the primary key of the layout prototypePortalException
- if a layout prototype with the primary key could not be foundpublic static LayoutPrototype getLayoutPrototypeByUuidAndCompanyId(String uuid, long companyId) throws PortalException
uuid
- the layout prototype's UUIDcompanyId
- the primary key of the companyPortalException
- if a matching layout prototype could not be foundpublic static List<LayoutPrototype> getLayoutPrototypes(int start, int end)
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 LayoutPrototypeModelImpl
. 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 layout prototypesend
- the upper bound of the range of layout prototypes (not inclusive)public static int getLayoutPrototypesCount()
public static String getOSGiServiceIdentifier()
public static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
PortalException
public static List<LayoutPrototype> search(long companyId, Boolean active, int start, int end, OrderByComparator<LayoutPrototype> obc)
public static int searchCount(long companyId, Boolean active)
public static LayoutPrototype updateLayoutPrototype(LayoutPrototype layoutPrototype)
layoutPrototype
- the layout prototypepublic static LayoutPrototype updateLayoutPrototype(long layoutPrototypeId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, boolean active, ServiceContext serviceContext) throws PortalException
PortalException
@Deprecated public static LayoutPrototype updateLayoutPrototype(long layoutPrototypeId, Map<Locale,String> nameMap, String description, boolean active, ServiceContext serviceContext) throws PortalException
updateLayoutPrototype(long, Map, Map, boolean,
ServiceContext)
PortalException
public static LayoutPrototypeLocalService getService()