com.quickblox.customobjects.model

Class QBCustomObject

java.lang.Object

com.quickblox.core.model.QBEntity

com.quickblox.core.model.QBBaseCustomObject

com.quickblox.customobjects.model.QBCustomObject

All Implemented Interfaces:

java.io.Serializable

public class QBCustomObject
extends QBBaseCustomObject

This class represents a record in Custom Objects module.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.quickblox.core.model.QBBaseCustomObject

className, fields

Fields inherited from class com.quickblox.core.model.QBEntity

createdAt, id, updatedAt

Constructor Summary

Constructors

Constructor and Description
QBCustomObject() Constructs a new QBCustomObject object
QBCustomObject(java.lang.String className) Constructs a new QBCustomObject object
QBCustomObject(java.lang.String className, java.lang.String id) Constructs a new QBCustomObject object

Method Summary

Modifier and Type	Method and Description
void	copyFieldsTo(QBCustomObject record)
java.lang.String	getCustomObjectId() Gets the Id af teh record
java.lang.String	getParentId() Gets the parent Id value
QBPermissions	getPermission() Gets the record's permissions
java.lang.Integer	getUserId() Gets the creator go the record
QBCustomObject	put(java.lang.String fieldName, java.lang.Object value) Puts field value where There are few types of class field: Integer String Float Boolean Date Array - array represents as string of values separated by coma symbol.
<E> QBCustomObject	putArray(java.lang.String fieldName, java.util.List<E> value) Puts the array value in field Each array could contains values one of the following type: Integer String Float Boolean In case of set wrong value to array it will be initialize with null value
QBCustomObject	putBoolean(java.lang.String fieldName, boolean value) Puts the Boolean value in field
QBCustomObject	putDate(java.lang.String fieldName, java.util.Date value) Puts the Date value in field
QBCustomObject	putFile(java.lang.String fieldName, java.lang.String fileId) Puts the file value in field
QBCustomObject	putFloat(java.lang.String fieldName, float value) Puts the Float value in field
QBCustomObject	putInteger(java.lang.String fieldName, int value) Puts the integer value in field
QBCustomObject	putLocation(java.lang.String fieldName, java.util.List<java.lang.Double> value) Puts the Location value in field
QBCustomObject	putString(java.lang.String fieldName, java.lang.String value) Puts the string value in field
void	setCustomObjectId(java.lang.String id) Sets the record's Id value
QBCustomObject	setNullFor(java.lang.String fieldName) Sets "null" for specified field.
void	setParentId(java.lang.String parentId) Sets the parent Id value
void	setPermission(QBPermissions permission) Sets the record's permissions
void	setUserId(java.lang.Integer userId) Sets the creator's Id value
java.lang.String	toString()

Methods inherited from class com.quickblox.core.model.QBBaseCustomObject

copyFieldsTo, get, getArray, getBoolean, getClassName, getDate, getFields, getFloat, getInteger, getLocation, getString, putFields, remove, setClassName, setFields

Methods inherited from class com.quickblox.core.model.QBEntity

copyFieldsTo, equals, getCreatedAt, getFCreatedAt, getFUpdatedAt, getId, getUpdatedAt, hashCode, setCreatedAt, setId, setUpdatedAt

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

QBCustomObject

public QBCustomObject()

Constructs a new QBCustomObject object

QBCustomObject

public QBCustomObject(java.lang.String className)

Constructs a new QBCustomObject object

Parameters:

className - the class name of the object related to

QBCustomObject

public QBCustomObject(java.lang.String className,
                      java.lang.String id)

Constructs a new QBCustomObject object

Parameters:

className - the class name of the object related to

id - ID of the object

Method Detail

getCustomObjectId

public java.lang.String getCustomObjectId()

Gets the Id af teh record

setCustomObjectId

public void setCustomObjectId(java.lang.String id)

Sets the record's Id value

Parameters:

id - The Id value to set

getUserId

public java.lang.Integer getUserId()

Gets the creator go the record

setUserId

public void setUserId(java.lang.Integer userId)

Sets the creator's Id value

Parameters:

userId - The creator's Id value to set

getPermission

public QBPermissions getPermission()

Gets the record's permissions

setPermission

public void setPermission(QBPermissions permission)

Sets the record's permissions

Parameters:

permission - An instance of QBPermissions class.

setParentId

public void setParentId(java.lang.String parentId)

Sets the parent Id value

Parameters:

parentId - The parent Id calue to set

getParentId

public java.lang.String getParentId()

Gets the parent Id value

put

public QBCustomObject put(java.lang.String fieldName,
                          java.lang.Object value)

Puts field value where There are few types of class field:

• Integer
• String
• Float
• Boolean
• Date
• Array - array represents as string of values separated by coma symbol. \n Array values could be next types^ Integer, String, Float, Boolean
• Location - array with 2 elements: longitude, latitude

Specified by:

put in class QBBaseCustomObject

Parameters:

fieldName - The name of field

value - The value of field

Returns:

QBCustomObject instance to chain operations

putInteger

public QBCustomObject putInteger(java.lang.String fieldName,
                                 int value)

Puts the integer value in field

Specified by:

putInteger in class QBBaseCustomObject

Parameters:

fieldName - The name of field

value - The value of field

Returns:

QBCustomObject instance to chain operations

putString

public QBCustomObject putString(java.lang.String fieldName,
                                java.lang.String value)

Puts the string value in field

Specified by:

putString in class QBBaseCustomObject

Parameters:

fieldName - is name of class created in admin panel quickblox.com

value - is fieldname value

Returns:

QBCustomObject with updated field's values

putFloat

public QBCustomObject putFloat(java.lang.String fieldName,
                               float value)

Puts the Float value in field

Specified by:

putFloat in class QBBaseCustomObject

Parameters:

fieldName - The name of field

value - The value of field

Returns:

QBCustomObject instance to chain operations

putBoolean

public QBCustomObject putBoolean(java.lang.String fieldName,
                                 boolean value)

Puts the Boolean value in field

Specified by:

putBoolean in class QBBaseCustomObject

Parameters:

fieldName - The name of field

value - The value of field

Returns:

QBCustomObject instance to chain operations

putDate

public QBCustomObject putDate(java.lang.String fieldName,
                              java.util.Date value)

Puts the Date value in field

Specified by:

putDate in class QBBaseCustomObject

Parameters:

fieldName - The name of field

value - The value of field

Returns:

QBCustomObject instance to chain operations

putLocation

public QBCustomObject putLocation(java.lang.String fieldName,
                                  java.util.List<java.lang.Double> value)

Puts the Location value in field

Specified by:

putLocation in class QBBaseCustomObject

Parameters:

fieldName - The name of field

value - The value of field

Returns:

QBCustomObject instance to chain operations

putArray

public <E> QBCustomObject putArray(java.lang.String fieldName,
                                   java.util.List<E> value)

Puts the array value in field Each array could contains values one of the following type:

• Integer
• String
• Float
• Boolean
• In case of set wrong value to array it will be initialize with null value

Specified by:

putArray in class QBBaseCustomObject

Parameters:

fieldName - The name of field

value - The value of field

Returns:

QBCustomObject instance to chain operations

putFile

public QBCustomObject putFile(java.lang.String fieldName,
                              java.lang.String fileId)

Puts the file value in field

Parameters:

fieldName - The name of field

fileId - The value of field, it's id

Returns:

QBCustomObject instance to chain operations

setNullFor

public QBCustomObject setNullFor(java.lang.String fieldName)

Sets "null" for specified field.

Parameters:

fieldName - The name of field

Returns:

QBCustomObject instance to chain operations

copyFieldsTo

public void copyFieldsTo(QBCustomObject record)

toString

public java.lang.String toString()

Overrides:

toString in class QBBaseCustomObject