org.exoplatform.services.cms.timeline

Interface TimelineService

public interface TimelineService

Supports to get all documents by time frame (days, months and years). The configuration of this component is found in /core/core-configuration/src/main/webapp/WEB-INF/conf/wcm-core/core-services-configuration.xml.

 <component>
     <key>org.exoplatform.services.cms.timeline.TimelineService</key>
     <type>org.exoplatform.services.cms.timeline.impl.TimelineServiceImpl</type>
     <init-params>
         <value-param>
             <name>itemPerTimeline</name>
             <value>5</value>
         </value-param>
     </init-params>
 </component>
 

Level API:

Experimental

Method Summary

Methods

Modifier and Type	Method and Description
List<javax.jcr.Node>	getDocumentsOfEarlierThisMonth(String nodePath, String workspace, SessionProvider sessionProvider, String userName, boolean byUser) Gets all documents earlier this month.
List<javax.jcr.Node>	getDocumentsOfEarlierThisMonth(String nodePath, String workspace, SessionProvider sessionProvider, String userName, boolean byUser, boolean isLimit) Gets all documents earlier this month.
List<javax.jcr.Node>	getDocumentsOfEarlierThisWeek(String nodePath, String workspace, SessionProvider sessionProvider, String userName, boolean byUser) Gets all documents earlier this week.
List<javax.jcr.Node>	getDocumentsOfEarlierThisWeek(String nodePath, String workspace, SessionProvider sessionProvider, String userName, boolean byUser, boolean isLimit) Gets all documents earlier this week.
List<javax.jcr.Node>	getDocumentsOfEarlierThisYear(String nodePath, String workspace, SessionProvider sessionProvider, String userName, boolean byUser) Gets all documents earlier this year.
List<javax.jcr.Node>	getDocumentsOfEarlierThisYear(String nodePath, String workspace, SessionProvider sessionProvider, String userName, boolean byUser, boolean isLimit) Gets all documents earlier this year.
List<javax.jcr.Node>	getDocumentsOfToday(String nodePath, String workspace, SessionProvider sessionProvider, String userName, boolean byUser) Gets all documents of today.
List<javax.jcr.Node>	getDocumentsOfToday(String nodePath, String workspace, SessionProvider sessionProvider, String userName, boolean byUser, boolean isLimit) Gets all documents of today.
List<javax.jcr.Node>	getDocumentsOfYesterday(String nodePath, String workspace, SessionProvider sessionProvider, String userName, boolean byUser) Gets all documents of yesterday.
List<javax.jcr.Node>	getDocumentsOfYesterday(String nodePath, String workspace, SessionProvider sessionProvider, String userName, boolean byUser, boolean isLimit) Gets all documents of yesterday.
int	getItemPerTimeline() Gets the number of items per category displayed in the Timeline view.

Method Detail

getDocumentsOfToday

List<javax.jcr.Node> getDocumentsOfToday(String nodePath,
                                       String workspace,
                                       SessionProvider sessionProvider,
                                       String userName,
                                       boolean byUser)
                                         throws Exception

Gets all documents of today.

Parameters:

nodePath - Path of the current node.

workspace - Name of the workspace.

sessionProvider - The session provider.

userName - The logged-in user.

byUser - Shows documents by current user or by all users.

Returns:

The list of documents.

Throws:

Exception - The exception

getDocumentsOfToday

List<javax.jcr.Node> getDocumentsOfToday(String nodePath,
                                       String workspace,
                                       SessionProvider sessionProvider,
                                       String userName,
                                       boolean byUser,
                                       boolean isLimit)
                                         throws Exception

Gets all documents of today.

Parameters:

nodePath - Path of the current node.

workspace - Name of the workspace.

sessionProvider - The session provider.

userName - The logged-in user.

byUser - Shows documents by current user or by all users.

isLimit - Indicates the limitation of query is enabled or not.

Returns:

The list of documents.

Throws:

Exception - The exception

getDocumentsOfYesterday

List<javax.jcr.Node> getDocumentsOfYesterday(String nodePath,
                                           String workspace,
                                           SessionProvider sessionProvider,
                                           String userName,
                                           boolean byUser)
                                             throws Exception

Gets all documents of yesterday.

Parameters:

nodePath - Path of the current node.

workspace - Name of the workspace.

sessionProvider - The session provider.

userName - The logged-in user.

byUser - Shows documents by current user or by all users.

Returns:

The list of documents.

Throws:

Exception - The exception

getDocumentsOfYesterday

List<javax.jcr.Node> getDocumentsOfYesterday(String nodePath,
                                           String workspace,
                                           SessionProvider sessionProvider,
                                           String userName,
                                           boolean byUser,
                                           boolean isLimit)
                                             throws Exception

Gets all documents of yesterday.

Parameters:

nodePath - Path of the current node.

workspace - Name of the workspace.

sessionProvider - The session provider.

userName - The logged-in user.

byUser - Shows documents by current user or by all users

isLimit - Indicates the limitation of query is enabled or not.

Returns:

The list of documents.

Throws:

Exception - The exception

getDocumentsOfEarlierThisWeek

List<javax.jcr.Node> getDocumentsOfEarlierThisWeek(String nodePath,
                                                 String workspace,
                                                 SessionProvider sessionProvider,
                                                 String userName,
                                                 boolean byUser)
                                                   throws Exception

Gets all documents earlier this week.

Parameters:

nodePath - Path of the current node.

workspace - Name of the workspace.

sessionProvider - The session provider.

userName - The logged-in user.

byUser - Shows documents by current user or by all users.

Returns:

The list of documents.

Throws:

Exception - The exception

getDocumentsOfEarlierThisWeek

List<javax.jcr.Node> getDocumentsOfEarlierThisWeek(String nodePath,
                                                 String workspace,
                                                 SessionProvider sessionProvider,
                                                 String userName,
                                                 boolean byUser,
                                                 boolean isLimit)
                                                   throws Exception

Gets all documents earlier this week.

Parameters:

nodePath - Path of the current node.

workspace - Name of the workspace.

sessionProvider - The session provider.

userName - The logged-in user.

byUser - Shows documents by current user or by all users

isLimit - Indicates the limitation of query is enabled or not.

Returns:

The list of documents.

Throws:

Exception - The exception

getDocumentsOfEarlierThisMonth

List<javax.jcr.Node> getDocumentsOfEarlierThisMonth(String nodePath,
                                                  String workspace,
                                                  SessionProvider sessionProvider,
                                                  String userName,
                                                  boolean byUser)
                                                    throws Exception

Gets all documents earlier this month.

Parameters:

nodePath - Path of the current node.

workspace - Name of the workspace.

sessionProvider - The session provider.

userName - The logged-in user.

byUser - Shows documents by current user or by all users.

Returns:

The list of documents.

Throws:

Exception - The exception

getDocumentsOfEarlierThisMonth

List<javax.jcr.Node> getDocumentsOfEarlierThisMonth(String nodePath,
                                                  String workspace,
                                                  SessionProvider sessionProvider,
                                                  String userName,
                                                  boolean byUser,
                                                  boolean isLimit)
                                                    throws Exception

Gets all documents earlier this month.

Parameters:

nodePath - Path of the current node.

workspace - Name of the workspace.

sessionProvider - The session provider.

userName - The logged-in user.

byUser - Shows documents by current user or by all users.

isLimit - Indicates the limitation of query is enabled or not.

Returns:

The list of documents.

Throws:

Exception - The exception

getDocumentsOfEarlierThisYear

List<javax.jcr.Node> getDocumentsOfEarlierThisYear(String nodePath,
                                                 String workspace,
                                                 SessionProvider sessionProvider,
                                                 String userName,
                                                 boolean byUser)
                                                   throws Exception

Gets all documents earlier this year.

Parameters:

nodePath - Path of the current node.

workspace - Name of the workspace.

sessionProvider - The session provider.

userName - The logged-in user.

byUser - Shows documents by current user or by all users.

Returns:

The list of documents.

Throws:

Exception - The exception

getDocumentsOfEarlierThisYear

List<javax.jcr.Node> getDocumentsOfEarlierThisYear(String nodePath,
                                                 String workspace,
                                                 SessionProvider sessionProvider,
                                                 String userName,
                                                 boolean byUser,
                                                 boolean isLimit)
                                                   throws Exception

Gets all documents earlier this year.

Parameters:

nodePath - Path of the current node.

workspace - Name of the workspace.

sessionProvider - The session provider.

userName - The logged-in user.

byUser - Shows documents by current user or by all users

isLimit - Indicates the limitation of query is enabled or not.

Returns:

The list of documents.

Throws:

Exception - The exception

getItemPerTimeline

int getItemPerTimeline()

Gets the number of items per category displayed in the Timeline view.

Returns:

The number of items.