com.box.sdk

Class BoxTask.Info

Object

BoxJSONObject

BoxResource.Info

BoxTask.Info

Enclosing class:

BoxTask

public class BoxTask.Info
extends BoxResource.Info

Contains information about a BoxTask.

Constructor Summary

Constructors

Constructor and Description
Info() Constructs an empty Info object.
Info(String json) Constructs an Info object by parsing information from a JSON string.

Method Summary

Modifier and Type	Method and Description
String	getCompletionRule() Returns the completion rule for the task.
Date	getCreatedAt() Gets when this task was created.
BoxUser.Info	getCreatedBy() Gets the user who created this task.
Date	getDueAt() Gets the date at which this task is due.
BoxFile.Info	getItem() Gets the file associated with this task.
String	getMessage() Gets the message that will be included with this task.
BoxTask	getResource() Gets the resource associated with this Info.
List<BoxTaskAssignment.Info>	getTaskAssignments() Gets the collection of task assignments associated with this task.
String	getTaskType() Gets the action the task assignee will be prompted to do.
boolean	isCompleted() Gets whether or not this task has been completed.
void	setCompletionRule(BoxTask.CompletionRule completionRule) Sets the task's completion rule.
void	setDueAt(Date dueAt) Sets the task's due date.
void	setMessage(String message) Sets the task's message.

Methods inherited from class BoxResource.Info

getID

Methods inherited from class BoxJSONObject

clearPendingChanges, getJson, getPendingChanges, getPendingChangesAsJsonObject

Methods inherited from class Object

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

Constructor Detail

Info

public Info()

Constructs an empty Info object.

Info

public Info(String json)

Constructs an Info object by parsing information from a JSON string.

Parameters:

json - the JSON string to parse.

Method Detail

getResource

public BoxTask getResource()

Description copied from class: BoxResource.Info

Gets the resource associated with this Info.

Specified by:

getResource in class BoxResource.Info

Returns:

the associated resource.

getItem

public BoxFile.Info getItem()

Gets the file associated with this task.

Returns:

the file associated with this task.

getDueAt

public Date getDueAt()

Gets the date at which this task is due.

Returns:

the date at which this task is due.

setDueAt

public void setDueAt(Date dueAt)

Sets the task's due date.

Parameters:

dueAt - the task's due date.

getTaskType

public String getTaskType()

Gets the action the task assignee will be prompted to do.

Returns:

the action the task assignee will be prompted to do.

getCompletionRule

public String getCompletionRule()

Returns the completion rule for the task.

Returns:

the task completion rule.

setCompletionRule

public void setCompletionRule(BoxTask.CompletionRule completionRule)

Sets the task's completion rule.

Parameters:

completionRule - the new completion rule.

getMessage

public String getMessage()

Gets the message that will be included with this task.

Returns:

the message that will be included with this task.

setMessage

public void setMessage(String message)

Sets the task's message.

Parameters:

message - the task's new message.

getTaskAssignments

public List<BoxTaskAssignment.Info> getTaskAssignments()

Gets the collection of task assignments associated with this task.

Returns:

the collection of task assignments associated with this task.

isCompleted

public boolean isCompleted()

Gets whether or not this task has been completed.

Returns:

whether or not this task has been completed.

getCreatedBy

public BoxUser.Info getCreatedBy()

Gets the user who created this task.

Returns:

the user who created this task.

getCreatedAt

public Date getCreatedAt()

Gets when this task was created.

Returns:

when this task was created.