Java Doc for ContentEngine.java in  » J2EE » fleXive » com » flexive » shared » interfaces » 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 » J2EE » fleXive » com.flexive.shared.interfaces 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


com.flexive.shared.interfaces.ContentEngine

All known Subclasses:   com.flexive.ejb.beans.ContentEngineBean,
ContentEngine
public interface ContentEngine (Code)
ContentEngine
author:
   Markus Plesser (markus.plesser@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)




Method Summary
 FxPKcreateNewVersion(FxContent content)
    
 longgetBinaryId(FxPK pk, String xpath, FxLanguage language)
     Get the binary id for the given XPath.
 FxContentSecurityInfogetContentSecurityInfo(FxPK pk)
    
 FxContentVersionInfogetContentVersionInfo(FxPK id)
    
 List<FxPK>getPKsForType(long typeId, boolean onePkPerInstance)
    

Returns all primary keys for the given type.

 intgetReferencedContentCount(FxPK pk)
    
 FxContentinitialize(long typeId, long mandatorId, long prefACL, long prefStep, long prefLang)
    
 FxContentinitialize(long typeId)
     Initialize a new FxContent instance for a type with default values.
 FxContentinitialize(String typeName)
     Initialize a new FxContent instance for a type with default values.
 FxContentload(FxPK pk)
    
 FxContentprepareSave(FxContent content)
     Prepare a content for a save or create operation (resolves binaries for script processing, etc.).
 voidremove(FxPK pk)
    
 intremoveForType(long typeId)
     Remove all instances of the given type.
 voidremoveVersion(FxPK pk)
     Remove a content's version.
 FxPKsave(FxContent content)
    



Method Detail
createNewVersion
FxPK createNewVersion(FxContent content) throws FxApplicationException(Code)
Create a new version for an existing content instance
Parameters:
  content - the content to persist the primary key of the contents new version
throws:
  FxApplicationException - TODO
throws:
  FxCreateException - on errors
throws:
  FxUpdateException - on errors
throws:
  FxNoAccessException -



getBinaryId
long getBinaryId(FxPK pk, String xpath, FxLanguage language) throws FxApplicationException(Code)
Get the binary id for the given XPath. The root ("/") XPath will return the contents preview binary id. An invalid XPath or no associated binary id will throw an FxNotFoundException or FxInvalidParameterException. Security will be checked and FxNoAccessException thrown if restricted.
Parameters:
  pk - primary key
Parameters:
  xpath - XPath
Parameters:
  language - the language (if null, the user ticket language will be used) binary id
throws:
  FxApplicationException - on errors



getContentSecurityInfo
FxContentSecurityInfo getContentSecurityInfo(FxPK pk) throws FxApplicationException(Code)
Get all security relevant information about a content instance identified by its primary key
Parameters:
  pk - primary key to query security information for FxContentSecurityInfo
throws:
  FxApplicationException - TODO



getContentVersionInfo
FxContentVersionInfo getContentVersionInfo(FxPK id) throws FxApplicationException(Code)
Get information about the versions used for a content id
Parameters:
  id - the id to query version information for FxContentVersionInfo
throws:
  FxApplicationException - on errors



getPKsForType
List<FxPK> getPKsForType(long typeId, boolean onePkPerInstance) throws FxApplicationException(Code)

Returns all primary keys for the given type. Since this method does not implement security, it may only be called by the global supervisor. You can use the search engine to achieve the same, just with security enabled, with

final List<FxPK> folderPks = new SqlQueryBuilder().select("@pk").type("FOLDER").getResult().collectColumn(1);
Parameters:
  typeId - the type to request the primary keys for
Parameters:
  onePkPerInstance - return one primary key per instance (with max version) or one per actual version? list containing the primary keys
throws:
  FxApplicationException - on errors



getReferencedContentCount
int getReferencedContentCount(FxPK pk) throws FxApplicationException(Code)
Get the number of references that exist for the requested content
Parameters:
  pk - primary key of the requested content number of references that exist for the requested content
throws:
  FxApplicationException - on errors



initialize
FxContent initialize(long typeId, long mandatorId, long prefACL, long prefStep, long prefLang) throws FxApplicationException(Code)
Initialize a new FxContent instance with preferred acl, step and language
Parameters:
  typeId - type to use
Parameters:
  mandatorId - mandator to assign this content (has to be available for the type!)
Parameters:
  prefACL - preferred acl, if not applicable the best fit will be used
Parameters:
  prefStep - preferred step, if not applicable the best fit will be used
Parameters:
  prefLang - preferred language, if not applicable the best fit will be used FxContent
throws:
  FxApplicationException - TODO
throws:
  FxLoadException - on initialization errors



initialize
FxContent initialize(long typeId) throws FxApplicationException(Code)
Initialize a new FxContent instance for a type with default values. mandator, ACL, Step and Lang will be taken on a "first-useable" basis
Parameters:
  typeId - type to use content instance
throws:
  FxApplicationException - on errors



initialize
FxContent initialize(String typeName) throws FxApplicationException(Code)
Initialize a new FxContent instance for a type with default values. mandator, ACL, Step and Lang will be taken on a "first-useable" basis
Parameters:
  typeName - type to use content instance
throws:
  FxApplicationException - on errors



load
FxContent load(FxPK pk) throws FxApplicationException(Code)
Load a content
Parameters:
  pk - primary key to load FxContent
throws:
  FxApplicationException - TODO
throws:
  FxLoadException -
throws:
  FxNoAccessException -
throws:
  FxNotFoundException - if no instance for this primary key was found



prepareSave
FxContent prepareSave(FxContent content) throws FxApplicationException(Code)
Prepare a content for a save or create operation (resolves binaries for script processing, etc.). This is optional and is not required to be called prior to saving, it exists to have metadata available in GUI's prior to saving.
Parameters:
  content - the content to prepare the prepared content
throws:
  FxInvalidParameterException - on errors
throws:
  FxDbException - on errors



remove
void remove(FxPK pk) throws FxApplicationException(Code)
Remove a content
Parameters:
  pk - primary key of the content to remove
throws:
  FxApplicationException - TODO
throws:
  com.flexive.shared.exceptions.FxRemoveException - on errors
throws:
  FxNoAccessException - on errors



removeForType
int removeForType(long typeId) throws FxApplicationException(Code)
Remove all instances of the given type. Beans using this method should apply very strict security restrictions!
Parameters:
  typeId - affected FxType number of instances removed
throws:
  FxApplicationException - TODO
throws:
  com.flexive.shared.exceptions.FxRemoveException - on errors



removeVersion
void removeVersion(FxPK pk) throws FxApplicationException(Code)
Remove a content's version. If the content consists only of this specific version the whole content is removed
Parameters:
  pk - primary key of a distinct version to remove
throws:
  FxApplicationException - TODO
throws:
  com.flexive.shared.exceptions.FxRemoveException - on errors
throws:
  FxNoAccessException - on errors



save
FxPK save(FxContent content) throws FxApplicationException(Code)
Store an existing content or create a new one
Parameters:
  content - the content to persist the primary key of the content
throws:
  FxApplicationException - TODO
throws:
  FxCreateException - on errors
throws:
  FxUpdateException - on errors
throws:
  FxNoAccessException -



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.