Clearspace API (2.0.15) Web Services Client Javadocs

com.jivesoftware.community.webservices
Class WSJiveObject

java.lang.Object
  extended by com.jivesoftware.community.webservices.WSJiveObject
Direct Known Subclasses:
WSAuditMessage, WSAvatar, WSBinaryBody, WSBlog, WSBlogPost, WSCheckPoint, WSContentTag, WSDocument, WSForumThread, WSGroup, WSJiveContainer, WSPoll, WSPrivateMessage, WSPrivateMessageFolder, WSStatusLevel, WSStatusLevelScenario

public class WSJiveObject
extends java.lang.Object

Super-class of other jive webservice objects. Contains the unique id of the object and its type.


Field Summary
protected  long id
           
protected  int objectType
           
 
Constructor Summary
WSJiveObject()
          Create a new instance of this object.
WSJiveObject(long id, int objectType)
          Create a new instance of this object.
 
Method Summary
 boolean equals(java.lang.Object o)
           
 long getID()
          Retrieve the unique identifier for the jive object, or -1 if the object hasn't yet been added/inserted into the system.
 int getObjectType()
          Return the object type of the jive object.
 int hashCode()
           
 void setID(long ID)
          Set the unique id of this object.
 void setObjectType(int objectType)
          Sets the object type of the jive object.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

id

protected long id

objectType

protected int objectType
Constructor Detail

WSJiveObject

public WSJiveObject(long id,
                    int objectType)
Create a new instance of this object.

Parameters:
id - the unique identifier for the jive object.
objectType - the object type of the jive object.

WSJiveObject

public WSJiveObject()
Create a new instance of this object.

Method Detail

getID

public long getID()
Retrieve the unique identifier for the jive object, or -1 if the object hasn't yet been added/inserted into the system.

Returns:
the unique identifier for the jive object.

setID

public void setID(long ID)
Set the unique id of this object.

Parameters:
ID - the unique id of this object.

getObjectType

public int getObjectType()
Return the object type of the jive object.

Returns:
the object type of the jive object.

setObjectType

public void setObjectType(int objectType)
Sets the object type of the jive object.

Parameters:
objectType - the object type of the jive object.

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

Clearspace Project Page

Copyright © 1999-2007 Jive Software.