com.baasbox.android

Class BaasObject

java.lang.Object

com.baasbox.android.BaasObject

All Implemented Interfaces:

android.os.Parcelable

Direct Known Subclasses:

BaasDocument, BaasFile

public abstract class BaasObject
extends java.lang.Object
implements android.os.Parcelable

Base class for remote resources that can be saved and retrieved from BaasBox.

Since:

0.7.3

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method and Description
BaasDocument	asDocument()
BaasFile	asFile()
abstract java.lang.String	getAuthor() The username of the owner of this object, or null if this object is new.
abstract java.lang.String	getCreationDate() The date this object was created on the server, or null if the object is new.
abstract java.lang.String	getId() The id of this object on the server.
abstract long	getVersion() The version number of this object.
RequestToken	grant(Grant grant, java.lang.String username, BaasHandler<java.lang.Void> handler) Asynchronously grants the access grant to this object to username.
abstract RequestToken	grant(Grant grant, java.lang.String username, int flags, BaasHandler<java.lang.Void> handler) Asynchronously grants the access grant to this object to username.
RequestToken	grantAll(Grant grant, java.lang.String role, BaasHandler<java.lang.Void> handler) Asynchronously grants the access grant to this object to users with role.
abstract RequestToken	grantAll(Grant grant, java.lang.String role, int flags, BaasHandler<java.lang.Void> handler) Asynchronously grants the access grant to this object to users with role.
abstract BaasResult<java.lang.Void>	grantAllSync(Grant grant, java.lang.String role) Synchronously grants the acces grant to this object to all users in role
abstract BaasResult<java.lang.Void>	grantSync(Grant grant, java.lang.String user) Synchronously grants the access grant to this object to username.
abstract boolean	isDirty()
abstract boolean	isDocument()
abstract boolean	isFile()
boolean	isNew() Returns true if this object has no conunterpart on the BaasBox server.
RequestToken	revoke(Grant grant, java.lang.String username, BaasHandler<java.lang.Void> handler) Asynchronously revoke the access grant to this object from username.
abstract RequestToken	revoke(Grant grant, java.lang.String username, int flags, BaasHandler<java.lang.Void> handler) Asynchronously revoke the access grant to this object to username.
RequestToken	revokeAll(Grant grant, java.lang.String role, BaasHandler<java.lang.Void> handler) Asynchronously revokes the access grant to this object from users with role.
abstract RequestToken	revokeAll(Grant grant, java.lang.String role, int flags, BaasHandler<java.lang.Void> handler) Asynchronously revokes the access grant to this object from users with role.
abstract BaasResult<java.lang.Void>	revokeAllSync(Grant grant, java.lang.String role) Synchronously revokes the acces grant to this object from all users in role
abstract BaasResult<java.lang.Void>	revokeSync(Grant grant, java.lang.String username) Synchronously revokes the access grant to this object from username.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface android.os.Parcelable

describeContents, writeToParcel

Method Detail

getAuthor

public abstract java.lang.String getAuthor()

The username of the owner of this object, or null if this object is new.

Returns:

a username as String or null

getCreationDate

public abstract java.lang.String getCreationDate()

The date this object was created on the server, or null if the object is new.

Returns:

a string representation of a date.

getVersion

public abstract long getVersion()

The version number of this object.

Returns:

a long version number

grant

public final RequestToken grant(Grant grant,
                                java.lang.String username,
                                BaasHandler<java.lang.Void> handler)

Asynchronously grants the access grant to this object to username. The outcome of the request is handed to the provided handler.

Parameters:

grant - a non null Grant

username - a non null username

handler - an handler that will receive the outcome of the request.

Returns:

a RequestToken to manage the asynchronous request

grantAll

public final RequestToken grantAll(Grant grant,
                                   java.lang.String role,
                                   BaasHandler<java.lang.Void> handler)

Asynchronously grants the access grant to this object to users with role. The outcome of the request is handed to the provided handler.

Parameters:

grant - a non null Grant

role - a non null username

handler - an handler that will receive the outcome of the request.

Returns:

a RequestToken to manage the asynchronous request

grantAllSync

public abstract BaasResult<java.lang.Void> grantAllSync(Grant grant,
                                                        java.lang.String role)

Synchronously grants the acces grant to this object to all users in role

Parameters:

grant - a non null Grant

role - a non null role

Returns:

the outcome of the request wrapped in a BaasResult

grantSync

public abstract BaasResult<java.lang.Void> grantSync(Grant grant,
                                                     java.lang.String user)

Synchronously grants the access grant to this object to username.

Parameters:

grant - a non null Grant

user - a non null username

Returns:

the outcome of the request wrapped in a BaasResult

isNew

public final boolean isNew()

Returns true if this object has no conunterpart on the BaasBox server.

Returns:

true if this object has no conunterpart on the BaasBox server

isDirty

public abstract boolean isDirty()

getId

public abstract java.lang.String getId()

The id of this object on the server. New objects created locally have no id.

Returns:

a uuid as a String or null.

revoke

public final RequestToken revoke(Grant grant,
                                 java.lang.String username,
                                 BaasHandler<java.lang.Void> handler)

Asynchronously revoke the access grant to this object from username. The outcome of the request is handed to the provided handler.

Parameters:

grant - a non null Grant

username - a non null username

handler - an handler that will receive the outcome of the request.

Returns:

a RequestToken to manage the asynchronous request

grant

public abstract RequestToken grant(Grant grant,
                                   java.lang.String username,
                                   int flags,
                                   BaasHandler<java.lang.Void> handler)

Asynchronously grants the access grant to this object to username. The outcome of the request is handed to the provided handler.

Parameters:

grant - a non null Grant

username - a non null username

flags - RequestOptions

handler - an handler that will receive the outcome of the request.

Returns:

a RequestToken to manage the asynchronous request

revoke

public abstract RequestToken revoke(Grant grant,
                                    java.lang.String username,
                                    int flags,
                                    BaasHandler<java.lang.Void> handler)

Asynchronously revoke the access grant to this object to username. The outcome of the request is handed to the provided handler.

Parameters:

grant - a non null Grant

username - a non null username

flags - RequestOptions

handler - an handler that will receive the outcome of the request.

Returns:

a RequestToken to manage the asynchronous request

revokeAll

public final RequestToken revokeAll(Grant grant,
                                    java.lang.String role,
                                    BaasHandler<java.lang.Void> handler)

Asynchronously revokes the access grant to this object from users with role. The outcome of the request is handed to the provided handler.

Parameters:

grant - a non null Grant

role - a non null username

handler - an handler that will receive the outcome of the request.

Returns:

a RequestToken to manage the asynchronous request

grantAll

public abstract RequestToken grantAll(Grant grant,
                                      java.lang.String role,
                                      int flags,
                                      BaasHandler<java.lang.Void> handler)

Asynchronously grants the access grant to this object to users with role. The outcome of the request is handed to the provided handler.

Parameters:

grant - a non null Grant

role - a non null username

flags - RequestOptions

handler - an handler that will receive the outcome of the request.

Returns:

a RequestToken to manage the asynchronous request

revokeAll

public abstract RequestToken revokeAll(Grant grant,
                                       java.lang.String role,
                                       int flags,
                                       BaasHandler<java.lang.Void> handler)

Asynchronously revokes the access grant to this object from users with role. The outcome of the request is handed to the provided handler.

Parameters:

grant - a non null Grant

role - a non null username

flags - RequestOptions

handler - an handler that will receive the outcome of the request.

Returns:

a RequestToken to manage the asynchronous request

revokeAllSync

public abstract BaasResult<java.lang.Void> revokeAllSync(Grant grant,
                                                         java.lang.String role)

Synchronously revokes the acces grant to this object from all users in role

Parameters:

grant - a non null Grant

role - a non null role

Returns:

the outcome of the request wrapped in a BaasResult

revokeSync

public abstract BaasResult<java.lang.Void> revokeSync(Grant grant,
                                                      java.lang.String username)

Synchronously revokes the access grant to this object from username.

Parameters:

grant - a non null Grant

username - a non null username

Returns:

the outcome of the request wrapped in a BaasResult

asDocument

public final BaasDocument asDocument()

isDocument

public abstract boolean isDocument()

asFile

public final BaasFile asFile()

isFile

public abstract boolean isFile()