Java Doc for DocumentType.java in  » Content-Management-System » daisy » org » outerj » daisy » repository » schema » 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 » Content Management System » daisy » org.outerj.daisy.repository.schema 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.outerj.daisy.repository.schema.DocumentType

All known Subclasses:   org.outerj.daisy.repository.commonimpl.schema.DocumentTypeImpl,
DocumentType
public interface DocumentType extends LabelEnabled,DescriptionEnabled(Code)
Describes a type of document in the repository.

Instances are retrieved from RepositorySchema .

A document type has some general properties like a name (which must be unique), and a locale-sensitive label and description. Next to these, a document type is associated with a number of FieldType s and PartType s.

The part types and field types belonging to a document type are ordered collections: the order in which you add them matters. To reorder them, first remove them all and re-add them.

A document type object can be read-only, in which case all state-modifying methods (i.e. all setters and the save method) will throw a RuntimeException. Whether a document type object is read-only or not depends on where you retrieved it from. The purpose of read-only document type objects is for caching, i.e. the same object can be used by multiple users who only which to consult the document type information, but not modify it.

The equals method for DocumentType is supported, two document types are equal if all their defining data is equal, with exception of the ID.





Method Summary
 FieldTypeUseaddFieldType(FieldType type, boolean required)
     The suplied field type should already exist in the repository, i.e.
 PartTypeUseaddPartType(PartType partType, boolean required)
     Adds a new association with a part type to this document type.
 voidclearFieldTypeUses()
    
 voidclearPartTypeUses()
     Removes all associations with part types.
 DocumentTypeDocumentgetExtendedXml()
     Same as DocumentType.getXml() but includes the full XML description of the associated part types and field types in the generated XML.
 FieldTypeUsegetFieldTypeUse(long id)
     Gets a 'field type use' by field type ID.
Parameters:
  id - ID of the field type.
 FieldTypeUsegetFieldTypeUse(String fieldTypeName)
     Gets a 'field type use' by field type name.
 FieldTypeUse[]getFieldTypeUses()
    
 longgetId()
    
 DategetLastModified()
     When was this document type last changed (persistently).
 longgetLastModifier()
     Who (which user) last changed this document type (persistently).
 StringgetName()
    
 PartTypeUsegetPartTypeUse(long id)
     Gets a 'part type use' by part type ID.
Parameters:
  id - ID of the part type.
 PartTypeUsegetPartTypeUse(String partTypeName)
     Gets a 'part type use' by part type name.
 PartTypeUse[]getPartTypeUses()
     Returns the part types contained by this document type.
 longgetUpdateCount()
    
 DocumentTypeDocumentgetXml()
    
 booleanhasFieldType(long id)
    
 booleanhasPartType(long id)
     Checks if this document type contains the part type with the given ID.
 booleanisDeprecated()
    
 voidsave()
    
 voidsetAllFromXml(DocumentTypeDocument.DocumentType documentTypeXml)
    
 voidsetDeprecated(boolean deprecated)
    
 voidsetName(String name)
    



Method Detail
addFieldType
FieldTypeUse addFieldType(FieldType type, boolean required)(Code)
The suplied field type should already exist in the repository, i.e. it should have an id != -1.

A field type is always added to the end, after the already existing field types.

The same field type can only be added once.




addPartType
PartTypeUse addPartType(PartType partType, boolean required)(Code)
Adds a new association with a part type to this document type.

The supplied part type should already exist in the repository, i.e. it should have an id != -1.

The same part type can be added only once.

A part type is always added to the end, after the already existing part types.
throws:
  IllegalArgumentException - if the part type's id is -1, or ifit is already contained by this document type.




clearFieldTypeUses
void clearFieldTypeUses()(Code)



clearPartTypeUses
void clearPartTypeUses()(Code)
Removes all associations with part types.



getExtendedXml
DocumentTypeDocument getExtendedXml()(Code)
Same as DocumentType.getXml() but includes the full XML description of the associated part types and field types in the generated XML.



getFieldTypeUse
FieldTypeUse getFieldTypeUse(long id)(Code)
Gets a 'field type use' by field type ID.
Parameters:
  id - ID of the field type. null if the field type is not associated with this document type



getFieldTypeUse
FieldTypeUse getFieldTypeUse(String fieldTypeName)(Code)
Gets a 'field type use' by field type name. null if the field type is not associated with this document type



getFieldTypeUses
FieldTypeUse[] getFieldTypeUses()(Code)



getId
long getId()(Code)



getLastModified
Date getLastModified()(Code)
When was this document type last changed (persistently). Returns null on newly created, not-yet-saved, document types.



getLastModifier
long getLastModifier()(Code)
Who (which user) last changed this document type (persistently). Returns -1 on newly created, not-yet-saved, document types.



getName
String getName()(Code)



getPartTypeUse
PartTypeUse getPartTypeUse(long id)(Code)
Gets a 'part type use' by part type ID.
Parameters:
  id - ID of the part type. null if the part type is not associated with this document type



getPartTypeUse
PartTypeUse getPartTypeUse(String partTypeName)(Code)
Gets a 'part type use' by part type name. null if the part type is not associated with this document type



getPartTypeUses
PartTypeUse[] getPartTypeUses()(Code)
Returns the part types contained by this document type. This is an ordered collection. The returned array is a newly created copy, thus modifying the order of the part types in the array, or putting other ones in it, won't modify this document type.



getUpdateCount
long getUpdateCount()(Code)



getXml
DocumentTypeDocument getXml()(Code)



hasFieldType
boolean hasFieldType(long id)(Code)



hasPartType
boolean hasPartType(long id)(Code)
Checks if this document type contains the part type with the given ID.



isDeprecated
boolean isDeprecated()(Code)



save
void save() throws RepositoryException(Code)



setAllFromXml
void setAllFromXml(DocumentTypeDocument.DocumentType documentTypeXml)(Code)



setDeprecated
void setDeprecated(boolean deprecated)(Code)



setName
void setName(String name)(Code)



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