Source Code Cross Referenced for SearchDatabaseHierarchy.java in  » ERP-CRM-Financial » sakai » org » sakaiproject » citation » api » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » ERP CRM Financial » sakai » org.sakaiproject.citation.api 
Source Cross Referenced  Class Diagram Java Document (Java Doc) 


01:        package org.sakaiproject.citation.api;
02:
03:        public interface SearchDatabaseHierarchy {
04:            public static final String ROOT_CATEGORY_NAME = "root";
05:            public static final String ROOT_CATEGORY_ID = "!root";
06:
07:            /**
08:             * Returns an Asset representing the database with the given databaseId.
09:             * This method is in place to provide individual database browse funcationality.
10:             * 
11:             * @param databaseId String representing the id of the database requested
12:             * @return an Asset if the database exists in this hierarchy, null otherwise.
13:             *
14:            public org.osid.repository.Asset getDatabase( String databaseId );
15:             */
16:
17:            /**
18:             * Returns the category within this hierarchy with the given category id
19:             * 
20:             * @param categoryId id of category to check
21:             * @return SearchCategory within this hierarchy with given category id; null
22:             * if the category id is not found in this hierarchy
23:             */
24:            public SearchCategory getCategory(String categoryId);
25:
26:            /**
27:             * Returns the number of hierarchical levels in this hierarchy.
28:             * 
29:             * @return number of hierarchical levels in this hierarchy.  One less than the number returned
30:             * provides the number of categorization levels - examples:
31:             * <ul>
32:             * <li>return value of 1 indicates there are just databases (no categorization)</li>
33:             * <li>return value of 5 indicates there are 4 categorization levels</li>
34:             * </ul>
35:             */
36:            public int getNumLevels();
37:
38:            /**
39:             * Returns the maximum number of searchable databases within this hierarchy.
40:             * This number defaults to 8 for now.
41:             * 
42:             * @return max number of searchable databases within this hierarchy
43:             */
44:            public int getNumMaxSearchableDb();
45:
46:            /**
47:             * Returns a list containing all categories in this hierarchy.
48:             * This list can be used to iterate through the entire hierarchy.
49:             * 
50:             * @return list containing the SearchCategory objects in this hierarchy.
51:             */
52:            public java.util.List getCategoryListing();
53:
54:            /**
55:             * Returns the default category in this hierarchy.  A default category will contain
56:             * at least one database and no sub-categories.
57:             * 
58:             * @return Default category in this hierarchy, or null if it does not exist.
59:             */
60:            public SearchCategory getDefaultCategory();
61:
62:            /**
63:             * Determines whether or not the given database is within this hierarchy.
64:             * 
65:             * @param databaseId database id to check
66:             * @return true if the database exists in this hierarchy,
67:             * false if it does not
68:             */
69:            public boolean isSearchableDatabase(String databaseId);
70:
71:            /**
72:             * Get the Repository associated with this hierarchy
73:             * 
74:             * @return Repository associated with this hierarchy
75:             */
76:            public org.osid.repository.Repository getRepository();
77:
78:            /**
79:             * Determines whether or not this hierarchy is properly configured.
80:             * This hierarchy could not be properly configured if the config xml files
81:             * are not found or there is an error in parsing them.
82:             * 
83:             * @return true if hierarchy is properly configured, false otherwise.
84:             */
85:            public boolean isConfigured();
86:        }
www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.