@ProviderType
public class LayoutSetPrototypeLocalServiceUtil
extends Object
LayoutSetPrototypeLocalServiceImpl
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.LayoutSetPrototypeLocalService
,
LayoutSetPrototypeLocalServiceBaseImpl
,
LayoutSetPrototypeLocalServiceImpl
Constructor and Description |
---|
LayoutSetPrototypeLocalServiceUtil() |
Modifier and Type | Method and Description |
---|---|
static LayoutSetPrototype |
addLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype)
Adds the layout set prototype to the database.
|
static LayoutSetPrototype |
addLayoutSetPrototype(long userId,
long companyId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
boolean active,
boolean layoutsUpdateable,
ServiceContext serviceContext) |
static LayoutSetPrototype |
addLayoutSetPrototype(long userId,
long companyId,
Map<Locale,String> nameMap,
String description,
boolean active,
boolean layoutsUpdateable,
ServiceContext serviceContext)
Deprecated.
As of Wilberforce (7.0.x), replaced by
addLayoutSetPrototype(long, long, Map, Map, boolean,
boolean, ServiceContext) |
static LayoutSetPrototype |
createLayoutSetPrototype(long layoutSetPrototypeId)
Creates a new layout set prototype with the primary key.
|
static LayoutSetPrototype |
deleteLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype)
Deletes the layout set prototype from the database.
|
static LayoutSetPrototype |
deleteLayoutSetPrototype(long layoutSetPrototypeId)
Deletes the layout set prototype with the primary key from the database.
|
static void |
deleteLayoutSetPrototypes() |
static void |
deleteNondefaultLayoutSetPrototypes(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 LayoutSetPrototype |
fetchLayoutSetPrototype(long layoutSetPrototypeId) |
static LayoutSetPrototype |
fetchLayoutSetPrototypeByUuidAndCompanyId(String uuid,
long companyId)
Returns the layout set prototype with the matching UUID and company.
|
static ActionableDynamicQuery |
getActionableDynamicQuery() |
static ExportActionableDynamicQuery |
getExportActionableDynamicQuery(PortletDataContext portletDataContext) |
static IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
static LayoutSetPrototype |
getLayoutSetPrototype(long layoutSetPrototypeId)
Returns the layout set prototype with the primary key.
|
static LayoutSetPrototype |
getLayoutSetPrototypeByUuidAndCompanyId(String uuid,
long companyId)
Returns the layout set prototype with the matching UUID and company.
|
static List<LayoutSetPrototype> |
getLayoutSetPrototypes(int start,
int end)
Returns a range of all the layout set prototypes.
|
static List<LayoutSetPrototype> |
getLayoutSetPrototypes(long companyId) |
static int |
getLayoutSetPrototypesCount()
Returns the number of layout set prototypes.
|
static String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static PersistedModel |
getPersistedModel(Serializable primaryKeyObj) |
static LayoutSetPrototypeLocalService |
getService() |
static List<LayoutSetPrototype> |
search(long companyId,
Boolean active,
int start,
int end,
OrderByComparator<LayoutSetPrototype> obc) |
static int |
searchCount(long companyId,
Boolean active) |
static LayoutSetPrototype |
updateLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype)
Updates the layout set prototype in the database or adds it if it does not yet exist.
|
static LayoutSetPrototype |
updateLayoutSetPrototype(long layoutSetPrototypeId,
Map<Locale,String> nameMap,
Map<Locale,String> descriptionMap,
boolean active,
boolean layoutsUpdateable,
ServiceContext serviceContext) |
static LayoutSetPrototype |
updateLayoutSetPrototype(long layoutSetPrototypeId,
Map<Locale,String> nameMap,
String description,
boolean active,
boolean layoutsUpdateable,
ServiceContext serviceContext)
Deprecated.
As of Wilberforce (7.0.x), replaced by
updateLayoutSetPrototype(long, Map, Map, boolean, boolean,
ServiceContext) |
static LayoutSetPrototype |
updateLayoutSetPrototype(long layoutSetPrototypeId,
String settings) |
public static LayoutSetPrototype addLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype)
layoutSetPrototype
- the layout set prototypepublic static LayoutSetPrototype addLayoutSetPrototype(long userId, long companyId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, boolean active, boolean layoutsUpdateable, ServiceContext serviceContext) throws PortalException
PortalException
@Deprecated public static LayoutSetPrototype addLayoutSetPrototype(long userId, long companyId, Map<Locale,String> nameMap, String description, boolean active, boolean layoutsUpdateable, ServiceContext serviceContext) throws PortalException
addLayoutSetPrototype(long, long, Map, Map, boolean,
boolean, ServiceContext)
PortalException
public static LayoutSetPrototype createLayoutSetPrototype(long layoutSetPrototypeId)
layoutSetPrototypeId
- the primary key for the new layout set prototypepublic static LayoutSetPrototype deleteLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype) throws PortalException
layoutSetPrototype
- the layout set prototypePortalException
public static LayoutSetPrototype deleteLayoutSetPrototype(long layoutSetPrototypeId) throws PortalException
layoutSetPrototypeId
- the primary key of the layout set prototypePortalException
- if a layout set prototype with the primary key could not be foundpublic static void deleteLayoutSetPrototypes() throws PortalException
PortalException
public static void deleteNondefaultLayoutSetPrototypes(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 LayoutSetPrototypeModelImpl
. 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 LayoutSetPrototypeModelImpl
. 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 LayoutSetPrototype fetchLayoutSetPrototype(long layoutSetPrototypeId)
public static LayoutSetPrototype fetchLayoutSetPrototypeByUuidAndCompanyId(String uuid, long companyId)
uuid
- the layout set prototype's UUIDcompanyId
- the primary key of the companynull
if a matching layout set prototype could not be foundpublic static ActionableDynamicQuery getActionableDynamicQuery()
public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static LayoutSetPrototype getLayoutSetPrototype(long layoutSetPrototypeId) throws PortalException
layoutSetPrototypeId
- the primary key of the layout set prototypePortalException
- if a layout set prototype with the primary key could not be foundpublic static LayoutSetPrototype getLayoutSetPrototypeByUuidAndCompanyId(String uuid, long companyId) throws PortalException
uuid
- the layout set prototype's UUIDcompanyId
- the primary key of the companyPortalException
- if a matching layout set prototype could not be foundpublic static List<LayoutSetPrototype> getLayoutSetPrototypes(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 LayoutSetPrototypeModelImpl
. 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 set prototypesend
- the upper bound of the range of layout set prototypes (not inclusive)public static List<LayoutSetPrototype> getLayoutSetPrototypes(long companyId)
public static int getLayoutSetPrototypesCount()
public static String getOSGiServiceIdentifier()
public static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
PortalException
public static List<LayoutSetPrototype> search(long companyId, Boolean active, int start, int end, OrderByComparator<LayoutSetPrototype> obc)
public static int searchCount(long companyId, Boolean active)
public static LayoutSetPrototype updateLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype)
layoutSetPrototype
- the layout set prototypepublic static LayoutSetPrototype updateLayoutSetPrototype(long layoutSetPrototypeId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, boolean active, boolean layoutsUpdateable, ServiceContext serviceContext) throws PortalException
PortalException
@Deprecated public static LayoutSetPrototype updateLayoutSetPrototype(long layoutSetPrototypeId, Map<Locale,String> nameMap, String description, boolean active, boolean layoutsUpdateable, ServiceContext serviceContext) throws PortalException
updateLayoutSetPrototype(long, Map, Map, boolean, boolean,
ServiceContext)
PortalException
public static LayoutSetPrototype updateLayoutSetPrototype(long layoutSetPrototypeId, String settings) throws PortalException
PortalException
public static LayoutSetPrototypeLocalService getService()