1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

/**
 * Vosao CMS. Simple CMS for Google App Engine.
 * 
 * Copyright (C) 2009-2010 Vosao development team.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * email: vosao.dev@gmail.com
 */

package org.vosao.velocity;

import java.util.List;

import org.vosao.business.decorators.TreeItemDecorator;
import org.vosao.entity.PageEntity;
import org.vosao.entity.TagEntity;

/**
 * @author Alexander Oleynik
 */
public interface TagVelocityService {

	List<TreeItemDecorator<TagEntity>> getTrees();
	
	TreeItemDecorator<TagEntity> getTree(String name);
	
	List<TagEntity> getTags(String pageURL);
	
	/**
	 * Get all pages by tag id.
	 * @param tagId - tag id
	 * @return found pages.
	 */
	List<PageEntity> getPagesById(Long tagId);
	
	/**
	 * Get all pages by tag id.
	 * @param tagId - tag id
	 * @param index - starting index.
	 * @param count - batch size.
	 * @return found pages.
	 */
	List<PageEntity> getPagesById(Long tagId, int index, int count);

	/**
	 * Get pages of tag selected by tag path in tags tree. Pages of all 
	 * children tags are also included.
	 * @param tagPaths - comma delimited list of tag paths. Path starts with /.
	 * @return pages by tags.
	 */
	List<PageEntity> getPagesByPath(String tagPaths);

	/**
	 * Get pages of tag selected by tag path in tags tree. Pages of all 
	 * children tags are also included.
	 * @param tagPath - path to tag like URL. Path starts with /.
	 * @param index - starting index.
	 * @param count - batch size.
	 * @return pages by tag.
	 */
	List<PageEntity> getPagesByPath(String tagPath, int index, int count);

}