Liferay 7.0-ce-b4

com.liferay.portal.service
Interface LayoutSetPrototypeLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
LayoutSetPrototypeLocalServiceWrapper

@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface LayoutSetPrototypeLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for LayoutSetPrototype. 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:
LayoutSetPrototypeLocalServiceUtil, LayoutSetPrototypeLocalServiceBaseImpl, com.liferay.portal.service.impl.LayoutSetPrototypeLocalServiceImpl

Method Summary
 LayoutSetPrototype addLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype)
          Adds the layout set prototype to the database.
 LayoutSetPrototype addLayoutSetPrototype(long userId, long companyId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, boolean active, boolean layoutsUpdateable, ServiceContext serviceContext)
           
 LayoutSetPrototype addLayoutSetPrototype(long userId, long companyId, Map<Locale,String> nameMap, String description, boolean active, boolean layoutsUpdateable, ServiceContext serviceContext)
          Deprecated. As of 7.0.0, replaced by addLayoutSetPrototype(long, long, Map, Map, boolean, boolean, ServiceContext)
 LayoutSetPrototype createLayoutSetPrototype(long layoutSetPrototypeId)
          Creates a new layout set prototype with the primary key.
 LayoutSetPrototype deleteLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype)
          Deletes the layout set prototype from the database.
 LayoutSetPrototype deleteLayoutSetPrototype(long layoutSetPrototypeId)
          Deletes the layout set prototype with the primary key from the database.
 void deleteLayoutSetPrototypes()
           
 void deleteNondefaultLayoutSetPrototypes(long companyId)
           
 PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
 DynamicQuery dynamicQuery()
           
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
<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.
<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.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows matching the dynamic query.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows matching the dynamic query.
 LayoutSetPrototype fetchLayoutSetPrototype(long layoutSetPrototypeId)
           
 LayoutSetPrototype fetchLayoutSetPrototypeByUuidAndCompanyId(String uuid, long companyId)
          Returns the layout set prototype with the matching UUID and company.
 ActionableDynamicQuery getActionableDynamicQuery()
           
 ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
           
 IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
           
 LayoutSetPrototype getLayoutSetPrototype(long layoutSetPrototypeId)
          Returns the layout set prototype with the primary key.
 LayoutSetPrototype getLayoutSetPrototypeByUuid(String uuid)
          Deprecated. As of 6.2.0, replaced by getLayoutSetPrototypeByUuidAndCompanyId(String, long)
 LayoutSetPrototype getLayoutSetPrototypeByUuidAndCompanyId(String uuid, long companyId)
          Returns the layout set prototype with the matching UUID and company.
 List<LayoutSetPrototype> getLayoutSetPrototypes(int start, int end)
          Returns a range of all the layout set prototypes.
 List<LayoutSetPrototype> getLayoutSetPrototypes(long companyId)
           
 int getLayoutSetPrototypesCount()
          Returns the number of layout set prototypes.
 String getOSGiServiceIdentifier()
          Returns the OSGi service identifier.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 List<LayoutSetPrototype> search(long companyId, Boolean active, int start, int end, OrderByComparator<LayoutSetPrototype> obc)
           
 int searchCount(long companyId, Boolean active)
           
 LayoutSetPrototype updateLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype)
          Updates the layout set prototype in the database or adds it if it does not yet exist.
 LayoutSetPrototype updateLayoutSetPrototype(long layoutSetPrototypeId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, boolean active, boolean layoutsUpdateable, ServiceContext serviceContext)
           
 LayoutSetPrototype updateLayoutSetPrototype(long layoutSetPrototypeId, Map<Locale,String> nameMap, String description, boolean active, boolean layoutsUpdateable, ServiceContext serviceContext)
          Deprecated. As of 7.0.0, replaced by updateLayoutSetPrototype(long, Map, Map, boolean, boolean, ServiceContext)
 LayoutSetPrototype updateLayoutSetPrototype(long layoutSetPrototypeId, String settings)
           
 

Method Detail

addLayoutSetPrototype

@Indexable(type=REINDEX)
LayoutSetPrototype addLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype)
Adds the layout set prototype to the database. Also notifies the appropriate model listeners.

Parameters:
layoutSetPrototype - the layout set prototype
Returns:
the layout set prototype that was added

addLayoutSetPrototype

@Deprecated
LayoutSetPrototype addLayoutSetPrototype(long userId,
                                                    long companyId,
                                                    Map<Locale,String> nameMap,
                                                    String description,
                                                    boolean active,
                                                    boolean layoutsUpdateable,
                                                    ServiceContext serviceContext)
                                         throws PortalException
Deprecated. As of 7.0.0, replaced by addLayoutSetPrototype(long, long, Map, Map, boolean, boolean, ServiceContext)

Throws:
PortalException

addLayoutSetPrototype

LayoutSetPrototype addLayoutSetPrototype(long userId,
                                         long companyId,
                                         Map<Locale,String> nameMap,
                                         Map<Locale,String> descriptionMap,
                                         boolean active,
                                         boolean layoutsUpdateable,
                                         ServiceContext serviceContext)
                                         throws PortalException
Throws:
PortalException

createLayoutSetPrototype

LayoutSetPrototype createLayoutSetPrototype(long layoutSetPrototypeId)
Creates a new layout set prototype with the primary key. Does not add the layout set prototype to the database.

Parameters:
layoutSetPrototypeId - the primary key for the new layout set prototype
Returns:
the new layout set prototype

deleteLayoutSetPrototype

@Indexable(type=DELETE)
@SystemEvent(action=1,
             type=1)
LayoutSetPrototype deleteLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype)
                                            throws PortalException
Deletes the layout set prototype from the database. Also notifies the appropriate model listeners.

Parameters:
layoutSetPrototype - the layout set prototype
Returns:
the layout set prototype that was removed
Throws:
PortalException

deleteLayoutSetPrototype

@Indexable(type=DELETE)
LayoutSetPrototype deleteLayoutSetPrototype(long layoutSetPrototypeId)
                                            throws PortalException
Deletes the layout set prototype with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
layoutSetPrototypeId - the primary key of the layout set prototype
Returns:
the layout set prototype that was removed
Throws:
PortalException - if a layout set prototype with the primary key could not be found

deleteLayoutSetPrototypes

void deleteLayoutSetPrototypes()
                               throws PortalException
Throws:
PortalException

deleteNondefaultLayoutSetPrototypes

void deleteNondefaultLayoutSetPrototypes(long companyId)
                                         throws PortalException
Throws:
PortalException

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                    throws PortalException
Specified by:
deletePersistedModel in interface PersistedModelLocalService
Throws:
PortalException

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

<T> 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

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

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.

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

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

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

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

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

fetchLayoutSetPrototype

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutSetPrototype fetchLayoutSetPrototype(long layoutSetPrototypeId)

fetchLayoutSetPrototypeByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutSetPrototype fetchLayoutSetPrototypeByUuidAndCompanyId(String uuid,
                                                                                                      long companyId)
Returns the layout set prototype with the matching UUID and company.

Parameters:
uuid - the layout set prototype's UUID
companyId - the primary key of the company
Returns:
the matching layout set prototype, or null if a matching layout set prototype could not be found

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getLayoutSetPrototype

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutSetPrototype getLayoutSetPrototype(long layoutSetPrototypeId)
                                         throws PortalException
Returns the layout set prototype with the primary key.

Parameters:
layoutSetPrototypeId - the primary key of the layout set prototype
Returns:
the layout set prototype
Throws:
PortalException - if a layout set prototype with the primary key could not be found

getLayoutSetPrototypeByUuid

@Deprecated
@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutSetPrototype getLayoutSetPrototypeByUuid(String uuid)
                                               throws PortalException
Deprecated. As of 6.2.0, replaced by getLayoutSetPrototypeByUuidAndCompanyId(String, long)

Throws:
PortalException

getLayoutSetPrototypeByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutSetPrototype getLayoutSetPrototypeByUuidAndCompanyId(String uuid,
                                                                                                    long companyId)
                                                           throws PortalException
Returns the layout set prototype with the matching UUID and company.

Parameters:
uuid - the layout set prototype's UUID
companyId - the primary key of the company
Returns:
the matching layout set prototype
Throws:
PortalException - if a matching layout set prototype could not be found

getLayoutSetPrototypes

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<LayoutSetPrototype> getLayoutSetPrototypes(long companyId)

getLayoutSetPrototypes

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<LayoutSetPrototype> getLayoutSetPrototypes(int start,
                                                                                         int end)
Returns a range of all the layout set prototypes.

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.

Parameters:
start - the lower bound of the range of layout set prototypes
end - the upper bound of the range of layout set prototypes (not inclusive)
Returns:
the range of layout set prototypes

getLayoutSetPrototypesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getLayoutSetPrototypesCount()
Returns the number of layout set prototypes.

Returns:
the number of layout set prototypes

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()
Returns the OSGi service identifier.

Returns:
the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<LayoutSetPrototype> search(long companyId,
                                                                         Boolean active,
                                                                         int start,
                                                                         int end,
                                                                         OrderByComparator<LayoutSetPrototype> obc)

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                         Boolean active)

updateLayoutSetPrototype

@Indexable(type=REINDEX)
LayoutSetPrototype updateLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype)
Updates the layout set prototype in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
layoutSetPrototype - the layout set prototype
Returns:
the layout set prototype that was updated

updateLayoutSetPrototype

@Deprecated
LayoutSetPrototype updateLayoutSetPrototype(long layoutSetPrototypeId,
                                                       Map<Locale,String> nameMap,
                                                       String description,
                                                       boolean active,
                                                       boolean layoutsUpdateable,
                                                       ServiceContext serviceContext)
                                            throws PortalException
Deprecated. As of 7.0.0, replaced by updateLayoutSetPrototype(long, Map, Map, boolean, boolean, ServiceContext)

Throws:
PortalException

updateLayoutSetPrototype

LayoutSetPrototype updateLayoutSetPrototype(long layoutSetPrototypeId,
                                            Map<Locale,String> nameMap,
                                            Map<Locale,String> descriptionMap,
                                            boolean active,
                                            boolean layoutsUpdateable,
                                            ServiceContext serviceContext)
                                            throws PortalException
Throws:
PortalException

updateLayoutSetPrototype

LayoutSetPrototype updateLayoutSetPrototype(long layoutSetPrototypeId,
                                            String settings)
                                            throws PortalException
Throws:
PortalException

Liferay 7.0-ce-b4