Liferay 6.0.5

com.liferay.portlet.documentlibrary.service
Interface DLFileVersionLocalService

All Known Implementing Classes:
DLFileVersionLocalServiceBaseImpl, DLFileVersionLocalServiceImpl, DLFileVersionLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface DLFileVersionLocalService

The interface for the d l file version local service.

Never modify or reference this interface directly. Always use DLFileVersionLocalServiceUtil to access the d l file version local service. Add custom service methods to DLFileVersionLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

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:
DLFileVersionLocalServiceUtil, DLFileVersionLocalServiceBaseImpl, DLFileVersionLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 DLFileVersion addDLFileVersion(DLFileVersion dlFileVersion)
          Adds the d l file version to the database.
 DLFileVersion createDLFileVersion(long fileVersionId)
          Creates a new d l file version with the primary key.
 void deleteDLFileVersion(DLFileVersion dlFileVersion)
          Deletes the d l file version from the database.
 void deleteDLFileVersion(long fileVersionId)
          Deletes the d l file version with the primary key from the database.
 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)
          Counts the number of rows that match the dynamic query.
 DLFileVersion getDLFileVersion(long fileVersionId)
          Gets the d l file version with the primary key.
 List<DLFileVersion> getDLFileVersions(int start, int end)
          Gets a range of all the d l file versions.
 int getDLFileVersionsCount()
          Gets the number of d l file versions.
 DLFileVersion getFileVersion(long fileVersionId)
           
 DLFileVersion getFileVersion(long groupId, long folderId, String name, String version)
           
 List<DLFileVersion> getFileVersions(long groupId, long folderId, String name, int status)
           
 DLFileVersion getLatestFileVersion(long groupId, long folderId, String name)
           
 DLFileVersion updateDescription(long fileVersionId, String description)
           
 DLFileVersion updateDLFileVersion(DLFileVersion dlFileVersion)
          Updates the d l file version in the database.
 DLFileVersion updateDLFileVersion(DLFileVersion dlFileVersion, boolean merge)
          Updates the d l file version in the database.
 

Method Detail

addDLFileVersion

DLFileVersion addDLFileVersion(DLFileVersion dlFileVersion)
                               throws SystemException
Adds the d l file version to the database. Also notifies the appropriate model listeners.

Parameters:
dlFileVersion - the d l file version to add
Returns:
the d l file version that was added
Throws:
SystemException - if a system exception occurred

createDLFileVersion

DLFileVersion createDLFileVersion(long fileVersionId)
Creates a new d l file version with the primary key. Does not add the d l file version to the database.

Parameters:
fileVersionId - the primary key for the new d l file version
Returns:
the new d l file version

deleteDLFileVersion

void deleteDLFileVersion(long fileVersionId)
                         throws PortalException,
                                SystemException
Deletes the d l file version with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
fileVersionId - the primary key of the d l file version to delete
Throws:
PortalException - if a d l file version with the primary key could not be found
SystemException - if a system exception occurred

deleteDLFileVersion

void deleteDLFileVersion(DLFileVersion dlFileVersion)
                         throws SystemException
Deletes the d l file version from the database. Also notifies the appropriate model listeners.

Parameters:
dlFileVersion - the d l file version to delete
Throws:
SystemException - if a system exception occurred

dynamicQuery

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

Parameters:
dynamicQuery - the dynamic query to search with
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 to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (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 to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

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

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

getDLFileVersion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileVersion getDLFileVersion(long fileVersionId)
                               throws PortalException,
                                      SystemException
Gets the d l file version with the primary key.

Parameters:
fileVersionId - the primary key of the d l file version to get
Returns:
the d l file version
Throws:
PortalException - if a d l file version with the primary key could not be found
SystemException - if a system exception occurred

getDLFileVersions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileVersion> getDLFileVersions(int start,
                                                                               int end)
                                      throws SystemException
Gets a range of all the d l file versions.

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 d l file versions to return
end - the upper bound of the range of d l file versions to return (not inclusive)
Returns:
the range of d l file versions
Throws:
SystemException - if a system exception occurred

getDLFileVersionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getDLFileVersionsCount()
                           throws SystemException
Gets the number of d l file versions.

Returns:
the number of d l file versions
Throws:
SystemException - if a system exception occurred

updateDLFileVersion

DLFileVersion updateDLFileVersion(DLFileVersion dlFileVersion)
                                  throws SystemException
Updates the d l file version in the database. Also notifies the appropriate model listeners.

Parameters:
dlFileVersion - the d l file version to update
Returns:
the d l file version that was updated
Throws:
SystemException - if a system exception occurred

updateDLFileVersion

DLFileVersion updateDLFileVersion(DLFileVersion dlFileVersion,
                                  boolean merge)
                                  throws SystemException
Updates the d l file version in the database. Also notifies the appropriate model listeners.

Parameters:
dlFileVersion - the d l file version to update
merge - whether to merge the d l file version 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 d l file version that was updated
Throws:
SystemException - if a system exception occurred

getFileVersion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileVersion getFileVersion(long fileVersionId)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

getFileVersion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileVersion getFileVersion(long groupId,
                                                                      long folderId,
                                                                      String name,
                                                                      String version)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

getFileVersions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileVersion> getFileVersions(long groupId,
                                                                             long folderId,
                                                                             String name,
                                                                             int status)
                                    throws SystemException
Throws:
SystemException

getLatestFileVersion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileVersion getLatestFileVersion(long groupId,
                                                                            long folderId,
                                                                            String name)
                                   throws PortalException,
                                          SystemException
Throws:
PortalException
SystemException

updateDescription

DLFileVersion updateDescription(long fileVersionId,
                                String description)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

Liferay 6.0.5