Liferay 6.1.2-ce-ga3

com.liferay.portlet.journal.service
Interface JournalStructureLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
JournalStructureLocalServiceBaseImpl, JournalStructureLocalServiceImpl, JournalStructureLocalServiceWrapper

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

The interface for the journal structure local service.

This is a local service. 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:
JournalStructureLocalServiceUtil, JournalStructureLocalServiceBaseImpl, JournalStructureLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 JournalStructure addJournalStructure(JournalStructure journalStructure)
          Adds the journal structure to the database.
 JournalStructure addStructure(long userId, long groupId, String structureId, boolean autoStructureId, String parentStructureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsd, ServiceContext serviceContext)
           
 void addStructureResources(JournalStructure structure, boolean addGroupPermissions, boolean addGuestPermissions)
           
 void addStructureResources(JournalStructure structure, String[] groupPermissions, String[] guestPermissions)
           
 void addStructureResources(long groupId, String structureId, boolean addGroupPermissions, boolean addGuestPermissions)
           
 void addStructureResources(long groupId, String structureId, String[] groupPermissions, String[] guestPermissions)
           
 void checkNewLine(long groupId, String structureId)
           
 JournalStructure copyStructure(long userId, long groupId, String oldStructureId, String newStructureId, boolean autoStructureId)
           
 JournalStructure createJournalStructure(long id)
          Creates a new journal structure with the primary key.
 JournalStructure deleteJournalStructure(JournalStructure journalStructure)
          Deletes the journal structure from the database.
 JournalStructure deleteJournalStructure(long id)
          Deletes the journal structure with the primary key from the database.
 void deleteStructure(JournalStructure structure)
           
 void deleteStructure(long groupId, String structureId)
           
 void deleteStructures(long groupId)
           
 DynamicQuery dynamicQuery()
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator 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 that match the dynamic query.
 JournalStructure fetchJournalStructure(long id)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 JournalStructure getJournalStructure(long id)
          Returns the journal structure with the primary key.
 JournalStructure getJournalStructureByUuidAndGroupId(String uuid, long groupId)
          Returns the journal structure with the UUID in the group.
 List<JournalStructure> getJournalStructures(int start, int end)
          Returns a range of all the journal structures.
 int getJournalStructuresCount()
          Returns the number of journal structures.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 JournalStructure getStructure(long id)
           
 JournalStructure getStructure(long groupId, String structureId)
           
 JournalStructure getStructure(long groupId, String structureId, boolean includeGlobalStructures)
           
 List<JournalStructure> getStructures()
           
 List<JournalStructure> getStructures(long groupId)
           
 List<JournalStructure> getStructures(long groupId, int start, int end)
           
 int getStructuresCount(long groupId)
           
 List<JournalStructure> search(long companyId, long[] groupIds, String keywords, int start, int end, OrderByComparator obc)
           
 List<JournalStructure> search(long companyId, long[] groupIds, String structureId, String name, String description, boolean andOperator, int start, int end, OrderByComparator obc)
           
 int searchCount(long companyId, long[] groupIds, String keywords)
           
 int searchCount(long companyId, long[] groupIds, String structureId, String name, String description, boolean andOperator)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 JournalStructure updateJournalStructure(JournalStructure journalStructure)
          Updates the journal structure in the database or adds it if it does not yet exist.
 JournalStructure updateJournalStructure(JournalStructure journalStructure, boolean merge)
          Updates the journal structure in the database or adds it if it does not yet exist.
 JournalStructure updateStructure(long groupId, String structureId, String parentStructureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String xsd, ServiceContext serviceContext)
           
 

Method Detail

addJournalStructure

JournalStructure addJournalStructure(JournalStructure journalStructure)
                                     throws SystemException
Adds the journal structure to the database. Also notifies the appropriate model listeners.

Parameters:
journalStructure - the journal structure
Returns:
the journal structure that was added
Throws:
SystemException - if a system exception occurred

createJournalStructure

JournalStructure createJournalStructure(long id)
Creates a new journal structure with the primary key. Does not add the journal structure to the database.

Parameters:
id - the primary key for the new journal structure
Returns:
the new journal structure

deleteJournalStructure

JournalStructure deleteJournalStructure(long id)
                                        throws PortalException,
                                               SystemException
Deletes the journal structure with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
id - the primary key of the journal structure
Returns:
the journal structure that was removed
Throws:
PortalException - if a journal structure with the primary key could not be found
SystemException - if a system exception occurred

deleteJournalStructure

JournalStructure deleteJournalStructure(JournalStructure journalStructure)
                                        throws SystemException
Deletes the journal structure from the database. Also notifies the appropriate model listeners.

Parameters:
journalStructure - the journal structure
Returns:
the journal structure that was removed
Throws:
SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException
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.

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
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException
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.

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
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchJournalStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalStructure fetchJournalStructure(long id)
                                       throws SystemException
Throws:
SystemException

getJournalStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalStructure getJournalStructure(long id)
                                     throws PortalException,
                                            SystemException
Returns the journal structure with the primary key.

Parameters:
id - the primary key of the journal structure
Returns:
the journal structure
Throws:
PortalException - if a journal structure with the primary key could not be found
SystemException - if a system exception occurred

getPersistedModel

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

getJournalStructureByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalStructure getJournalStructureByUuidAndGroupId(String uuid,
                                                                                              long groupId)
                                                     throws PortalException,
                                                            SystemException
Returns the journal structure with the UUID in the group.

Parameters:
uuid - the UUID of journal structure
groupId - the group id of the journal structure
Returns:
the journal structure
Throws:
PortalException - if a journal structure with the UUID in the group could not be found
SystemException - if a system exception occurred

getJournalStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<JournalStructure> getJournalStructures(int start,
                                                                                     int end)
                                            throws SystemException
Returns a range of all the journal structures.

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.

Parameters:
start - the lower bound of the range of journal structures
end - the upper bound of the range of journal structures (not inclusive)
Returns:
the range of journal structures
Throws:
SystemException - if a system exception occurred

getJournalStructuresCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getJournalStructuresCount()
                              throws SystemException
Returns the number of journal structures.

Returns:
the number of journal structures
Throws:
SystemException - if a system exception occurred

updateJournalStructure

JournalStructure updateJournalStructure(JournalStructure journalStructure)
                                        throws SystemException
Updates the journal structure in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
journalStructure - the journal structure
Returns:
the journal structure that was updated
Throws:
SystemException - if a system exception occurred

updateJournalStructure

JournalStructure updateJournalStructure(JournalStructure journalStructure,
                                        boolean merge)
                                        throws SystemException
Updates the journal structure in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
journalStructure - the journal structure
merge - whether to merge the journal structure with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
Returns:
the journal structure that was updated
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addStructure

JournalStructure addStructure(long userId,
                              long groupId,
                              String structureId,
                              boolean autoStructureId,
                              String parentStructureId,
                              Map<Locale,String> nameMap,
                              Map<Locale,String> descriptionMap,
                              String xsd,
                              ServiceContext serviceContext)
                              throws PortalException,
                                     SystemException
Throws:
PortalException
SystemException

addStructureResources

void addStructureResources(JournalStructure structure,
                           boolean addGroupPermissions,
                           boolean addGuestPermissions)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

addStructureResources

void addStructureResources(JournalStructure structure,
                           String[] groupPermissions,
                           String[] guestPermissions)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

addStructureResources

void addStructureResources(long groupId,
                           String structureId,
                           boolean addGroupPermissions,
                           boolean addGuestPermissions)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

addStructureResources

void addStructureResources(long groupId,
                           String structureId,
                           String[] groupPermissions,
                           String[] guestPermissions)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

checkNewLine

void checkNewLine(long groupId,
                  String structureId)
                  throws PortalException,
                         SystemException
Throws:
PortalException
SystemException

copyStructure

JournalStructure copyStructure(long userId,
                               long groupId,
                               String oldStructureId,
                               String newStructureId,
                               boolean autoStructureId)
                               throws PortalException,
                                      SystemException
Throws:
PortalException
SystemException

deleteStructure

void deleteStructure(JournalStructure structure)
                     throws PortalException,
                            SystemException
Throws:
PortalException
SystemException

deleteStructure

void deleteStructure(long groupId,
                     String structureId)
                     throws PortalException,
                            SystemException
Throws:
PortalException
SystemException

deleteStructures

void deleteStructures(long groupId)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

getStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalStructure getStructure(long id)
                              throws PortalException,
                                     SystemException
Throws:
PortalException
SystemException

getStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalStructure getStructure(long groupId,
                                                                       String structureId)
                              throws PortalException,
                                     SystemException
Throws:
PortalException
SystemException

getStructure

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalStructure getStructure(long groupId,
                                                                       String structureId,
                                                                       boolean includeGlobalStructures)
                              throws PortalException,
                                     SystemException
Throws:
PortalException
SystemException

getStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<JournalStructure> getStructures()
                                     throws SystemException
Throws:
SystemException

getStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<JournalStructure> getStructures(long groupId)
                                     throws SystemException
Throws:
SystemException

getStructures

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<JournalStructure> getStructures(long groupId,
                                                                              int start,
                                                                              int end)
                                     throws SystemException
Throws:
SystemException

getStructuresCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getStructuresCount(long groupId)
                       throws SystemException
Throws:
SystemException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<JournalStructure> search(long companyId,
                                                                       long[] groupIds,
                                                                       String keywords,
                                                                       int start,
                                                                       int end,
                                                                       OrderByComparator obc)
                              throws SystemException
Throws:
SystemException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<JournalStructure> search(long companyId,
                                                                       long[] groupIds,
                                                                       String structureId,
                                                                       String name,
                                                                       String description,
                                                                       boolean andOperator,
                                                                       int start,
                                                                       int end,
                                                                       OrderByComparator obc)
                              throws SystemException
Throws:
SystemException

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                         long[] groupIds,
                                                         String keywords)
                throws SystemException
Throws:
SystemException

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                         long[] groupIds,
                                                         String structureId,
                                                         String name,
                                                         String description,
                                                         boolean andOperator)
                throws SystemException
Throws:
SystemException

updateStructure

JournalStructure updateStructure(long groupId,
                                 String structureId,
                                 String parentStructureId,
                                 Map<Locale,String> nameMap,
                                 Map<Locale,String> descriptionMap,
                                 String xsd,
                                 ServiceContext serviceContext)
                                 throws PortalException,
                                        SystemException
Throws:
PortalException
SystemException

Liferay 6.1.2-ce-ga3