Java Doc for BaseUserVote.java in  » Issue-Tracking » scarab-0.21 » org » tigris » scarab » om » 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 » Issue Tracking » scarab 0.21 » org.tigris.scarab.om 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.tigris.scarab.om.BaseUserVote

All known Subclasses:   org.tigris.scarab.om.UserVote,
BaseUserVote
abstract public class BaseUserVote extends BaseObject implements org.apache.fulcrum.intake.Retrievable(Code)
You should not use this class directly. It should not even be extended all references should be to UserVote




Method Summary
public  UserVotecopy()
     Makes a copy of this object.
protected  UserVotecopyInto(UserVote copyObj)
    
public  ObjectgetByName(String name)
     Retrieves a field from the object by name passed in as a String.
public  ObjectgetByPeerName(String name)
     Retrieves a field from the object by name passed in as a String.
public  ObjectgetByPosition(int pos)
     Retrieves a field from the object by Position as specified in the xml schema.
public static synchronized  ListgetFieldNames()
     Generate a list of field names.
public  ModulegetModule()
     Returns the associated Module object.
public  ModulegetModule(Connection connection)
    
public  IntegergetModuleId()
    
public  UserVotePeergetPeer()
     returns a peer instance associated with this om.
public  ObjectKeygetPrimaryKey()
     returns an id that differentiates this object from others of its class.
public  StringgetQueryKey()
     get an id that differentiates this object from others of its class.
public  ScarabUsergetScarabUser()
     Returns the associated ScarabUser object.
public  ScarabUsergetScarabUser(Connection connection)
    
public  intgetTotalVotes()
    
public  intgetUsedVotes()
    
public  IntegergetUserId()
    
protected  booleanisCacheOnSave()
     Specify whether to cache the object after saving to the db.
public  voidsave()
     Stores the object in the database.
public  voidsave(String dbName)
     Stores the object in the database.
public  voidsave(Connection con)
     Stores the object in the database.
public  voidsetModule(Module v)
    
public  voidsetModuleId(Integer v)
    
public  voidsetModuleKey(ObjectKey key)
    
public  voidsetPrimaryKey(ObjectKey key)
    
public  voidsetPrimaryKey(Integer moduleId, Integer userId)
     Set the PrimaryKey using SimpleKeys.
public  voidsetPrimaryKey(String key)
     Set the PrimaryKey using a String.
public  voidsetQueryKey(String key)
     set an id that differentiates this object from others of its class.
public  voidsetScarabUser(ScarabUser v)
    
public  voidsetScarabUserKey(ObjectKey key)
    
public  voidsetTotalVotes(int v)
    
public  voidsetUsedVotes(int v)
    
public  voidsetUserId(Integer v)
    
public  StringtoString()
    



Method Detail
copy
public UserVote copy() throws TorqueException(Code)
Makes a copy of this object. It creates a new object filling in the simple attributes. It then fills all the association collections and sets the related objects to isNew=true.



copyInto
protected UserVote copyInto(UserVote copyObj) throws TorqueException(Code)



getByName
public Object getByName(String name)(Code)
Retrieves a field from the object by name passed in as a String.
Parameters:
  name - field name value



getByPeerName
public Object getByPeerName(String name)(Code)
Retrieves a field from the object by name passed in as a String. The String must be one of the static Strings defined in this Class' Peer.
Parameters:
  name - peer name value



getByPosition
public Object getByPosition(int pos)(Code)
Retrieves a field from the object by Position as specified in the xml schema. Zero-based.
Parameters:
  pos - position in xml schema value



getFieldNames
public static synchronized List getFieldNames()(Code)
Generate a list of field names. a list of field names



getModule
public Module getModule() throws TorqueException(Code)
Returns the associated Module object. If it was not retrieved before, the object is retrieved from the database the associated Module object
throws:
  TorqueException -



getModule
public Module getModule(Connection connection) throws TorqueException(Code)
Return the associated Module object If it was not retrieved before, the object is retrieved from the database using the passed connection
Parameters:
  connection - the connection used to retrieve the associated objectfrom the database, if it was not retrieved before the associated Module object
throws:
  TorqueException -



getModuleId
public Integer getModuleId()(Code)
Get the ModuleId Integer



getPeer
public UserVotePeer getPeer()(Code)
returns a peer instance associated with this om. Since Peer classes are not to have any instance attributes, this method returns the same instance for all member of this class. The method could therefore be static, but this would prevent one from overriding the behavior.



getPrimaryKey
public ObjectKey getPrimaryKey()(Code)
returns an id that differentiates this object from others of its class.



getQueryKey
public String getQueryKey()(Code)
get an id that differentiates this object from others of its class.



getScarabUser
public ScarabUser getScarabUser() throws TorqueException(Code)
Returns the associated ScarabUser object. If it was not retrieved before, the object is retrieved from the database the associated ScarabUser object
throws:
  TorqueException -



getScarabUser
public ScarabUser getScarabUser(Connection connection) throws TorqueException(Code)
Return the associated ScarabUser object If it was not retrieved before, the object is retrieved from the database using the passed connection
Parameters:
  connection - the connection used to retrieve the associated objectfrom the database, if it was not retrieved before the associated ScarabUser object
throws:
  TorqueException -



getTotalVotes
public int getTotalVotes()(Code)
Get the TotalVotes int



getUsedVotes
public int getUsedVotes()(Code)
Get the UsedVotes int



getUserId
public Integer getUserId()(Code)
Get the UserId Integer



isCacheOnSave
protected boolean isCacheOnSave()(Code)
Specify whether to cache the object after saving to the db. This method returns true



save
public void save() throws TorqueException(Code)
Stores the object in the database. If the object is new, it inserts it; otherwise an update is performed.
throws:
  TorqueException -



save
public void save(String dbName) throws TorqueException(Code)
Stores the object in the database. If the object is new, it inserts it; otherwise an update is performed. Note: this code is here because the method body is auto-generated conditionally and therefore needs to be in this file instead of in the super class, BaseObject.
Parameters:
  dbName -
throws:
  TorqueException -



save
public void save(Connection con) throws TorqueException(Code)
Stores the object in the database. If the object is new, it inserts it; otherwise an update is performed. This method is meant to be used as part of a transaction, otherwise use the save() method and the connection details will be handled internally
Parameters:
  con -
throws:
  TorqueException -



setModule
public void setModule(Module v) throws TorqueException(Code)
Declares an association between this object and a Module object
Parameters:
  v - Module
throws:
  TorqueException -



setModuleId
public void setModuleId(Integer v) throws TorqueException(Code)
Set the value of ModuleId
Parameters:
  v - new value



setModuleKey
public void setModuleKey(ObjectKey key) throws TorqueException(Code)
Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())



setPrimaryKey
public void setPrimaryKey(ObjectKey key) throws TorqueException(Code)
Set the PrimaryKey with an ObjectKey
Parameters:
  key -



setPrimaryKey
public void setPrimaryKey(Integer moduleId, Integer userId) throws TorqueException(Code)
Set the PrimaryKey using SimpleKeys.
Parameters:
  moduleId - Integer
Parameters:
  userId - Integer



setPrimaryKey
public void setPrimaryKey(String key) throws TorqueException(Code)
Set the PrimaryKey using a String.



setQueryKey
public void setQueryKey(String key) throws TorqueException(Code)
set an id that differentiates this object from others of its class.



setScarabUser
public void setScarabUser(ScarabUser v) throws TorqueException(Code)
Declares an association between this object and a ScarabUser object
Parameters:
  v - ScarabUser
throws:
  TorqueException -



setScarabUserKey
public void setScarabUserKey(ObjectKey key) throws TorqueException(Code)
Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())



setTotalVotes
public void setTotalVotes(int v)(Code)
Set the value of TotalVotes
Parameters:
  v - new value



setUsedVotes
public void setUsedVotes(int v)(Code)
Set the value of UsedVotes
Parameters:
  v - new value



setUserId
public void setUserId(Integer v) throws TorqueException(Code)
Set the value of UserId
Parameters:
  v - new value



toString
public String toString()(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.