com.box.sdk

Class BoxLock

Object

BoxJSONObject

BoxLock

public class BoxLock
extends BoxJSONObject

Represents a lock associated with a File on Box.

Constructor Summary

Constructors

Constructor and Description
BoxLock(String type, Date expiresAt) Constructs a base BoxLock object.
BoxLock(String type, Date expiresAt, Boolean isDownloadPrevented) Constructs a BoxLock object.

Method Summary

Modifier and Type	Method and Description
Date	getCreatedAt()
BoxUser.Info	getCreatedBy() User who created the lock.
Date	getExpiresAt() Gets a locks expiration date.
String	getId()
Boolean	getIsDownloadPrevented() Does the lock prevent downloads.
String	getType() Gets the lock type.
protected void	parseJSONMember(JsonObject.Member member) Invoked with a JSON member whenever this object is updated or created from a JSON object.

Methods inherited from class BoxJSONObject

clearPendingChanges, getJson, getPendingChanges, getPendingChangesAsJsonObject, getPendingJSONObject

Methods inherited from class Object

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

Constructor Detail

BoxLock

public BoxLock(String type,
               Date expiresAt)

Constructs a base BoxLock object.

Parameters:

type - lock type, "lock" or "unlock".

expiresAt - lock expiration date.

BoxLock

public BoxLock(String type,
               Date expiresAt,
               Boolean isDownloadPrevented)

Constructs a BoxLock object.

Parameters:

type - lock type, "lock" or "unlock".

expiresAt - lock expiration date.

isDownloadPrevented - if true, download is prevented while locked.

Method Detail

getType

public String getType()

Gets the lock type.

Returns:

the type of a lock.

getExpiresAt

public Date getExpiresAt()

Gets a locks expiration date.

Returns:

the locks expiration date.

getIsDownloadPrevented

public Boolean getIsDownloadPrevented()

Does the lock prevent downloads.

Returns:

true if lock prevents downloads.

getCreatedBy

public BoxUser.Info getCreatedBy()

User who created the lock.

Returns:

Lock creator.

getCreatedAt

public Date getCreatedAt()

Returns:

Lock's creation date.

getId

public String getId()

Returns:

Lock's ID.

parseJSONMember

protected void parseJSONMember(JsonObject.Member member)

Description copied from class: BoxJSONObject

Invoked with a JSON member whenever this object is updated or created from a JSON object.

Subclasses should override this method in order to parse any JSON members it knows about. This method is a no-op by default.

Parameters:

member - the JSON member to be parsed.