com.box.sdk

Class BoxFileRequest.Info

Object

BoxJSONObject

BoxResource.Info

BoxFileRequest.Info

Enclosing class:

BoxFileRequest

public class BoxFileRequest.Info
extends BoxResource.Info

Contains information about a BoxFileRequest.

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	getBaseUrl() Gets the base URL for the upload files link.
Date	getCreatedAt() Gets the date when the file request was created.
BoxUser.Info	getCreatedBy() Gets the user who created this file request.
String	getDescription() Gets the description of this file request.
String	getEtag() Gets a unique string identifying the version of the item.
Date	getExpiresAt() Gets the date after which a file request will no longer accept new submissions.
BoxFolder.Info	getFolder() Gets the folder that this file request is associated with.
Boolean	getIsDescriptionRequired() Gets whether a file request submitter is required to provide a description of the files they are submitting.
Boolean	getIsEmailRequired() Gets whether a file request submitter is required to provide their email address.
String	getPath() Gets the URL containing only the path (e.g.
BoxFileRequest	getResource() Gets the resource associated with this Info.
BoxFileRequest.Status	getStatus() Gets the status of the file request.
String	getTitle() Gets the title of file request.
String	getType() Gets the file request type.
Date	getUpdatedAt() Gets the date when the file request was last updated.
BoxUser.Info	getUpdatedBy() Gets the user who last modified this file request.
URL	getUrl() Gets the URL can be shared with users to let them upload files to the associated folder.
void	setBaseUrl(String baseUrl) Sets the base URL for the upload files link.
void	setDescription(String description) Sets the description of this file request.
void	setExpiresAt(Date expiresAt) Sets the date after which a file request will no longer accept new submissions.
void	setIsDescriptionRequired(Boolean isDescriptionRequired) Sets whether a file request submitter is required to provide a description of the files they are submitting.
void	setIsEmailRequired(Boolean isEmailRequired) Sets whether a file request submitter is required to provide their email address.
void	setStatus(BoxFileRequest.Status status) Sets the status of the file request.
void	setTitle(String title) Sets the title of file request.

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 BoxFileRequest 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.

getType

public String getType()

Gets the file request type.

Returns:

the file request type.

getCreatedAt

public Date getCreatedAt()

Gets the date when the file request was created.

Returns:

the date when the file request was created.

getCreatedBy

public BoxUser.Info getCreatedBy()

Gets the user who created this file request.

Returns:

the user who created this file request.

getDescription

public String getDescription()

Gets the description of this file request.

Returns:

the description of this file request.

setDescription

public void setDescription(String description)

Sets the description of this file request.

Parameters:

description - the file request's new description.

getEtag

public String getEtag()

Gets a unique string identifying the version of the item.

Returns:

a unique string identifying the version of the item.

getExpiresAt

public Date getExpiresAt()

Gets the date after which a file request will no longer accept new submissions.

Returns:

the date after which a file request will no longer accept new submissions.

setExpiresAt

public void setExpiresAt(Date expiresAt)

Sets the date after which a file request will no longer accept new submissions.

Parameters:

expiresAt - the date after which a file request will no longer accept new submissions.

getFolder

public BoxFolder.Info getFolder()

Gets the folder that this file request is associated with.

Returns:

the folder that this file request is associated with.

getIsDescriptionRequired

public Boolean getIsDescriptionRequired()

Gets whether a file request submitter is required to provide a description of the files they are submitting.

Returns:

whether a file request submitter is required to provide a description of the files they are submitting.

setIsDescriptionRequired

public void setIsDescriptionRequired(Boolean isDescriptionRequired)

Sets whether a file request submitter is required to provide a description of the files they are submitting.

Parameters:

isDescriptionRequired - whether a file request submitter is required to provide a description of the files they are submitting.

getIsEmailRequired

public Boolean getIsEmailRequired()

Gets whether a file request submitter is required to provide their email address.

Returns:

whether a file request submitter is required to provide their email address.

setIsEmailRequired

public void setIsEmailRequired(Boolean isEmailRequired)

Sets whether a file request submitter is required to provide their email address.

Parameters:

isEmailRequired - whether a file request submitter is required to provide their email address.

getStatus

public BoxFileRequest.Status getStatus()

Gets the status of the file request.

Returns:

the status of the file request

setStatus

public void setStatus(BoxFileRequest.Status status)

Sets the status of the file request.

Parameters:

status - the status of the file request

getTitle

public String getTitle()

Gets the title of file request.

Returns:

the title of file request.

setTitle

public void setTitle(String title)

Sets the title of file request.

Parameters:

title - the title of file request.

getUpdatedAt

public Date getUpdatedAt()

Gets the date when the file request was last updated.

Returns:

the date when the file request was last updated.

getUpdatedBy

public BoxUser.Info getUpdatedBy()

Gets the user who last modified this file request.

Returns:

the user who last modified this file request.

getUrl

public URL getUrl()

Gets the URL can be shared with users to let them upload files to the associated folder.

Returns:

the URL for files upload.

getBaseUrl

public String getBaseUrl()

Gets the base URL for the upload files link.

Returns:

the base url including protocol and hostname.

setBaseUrl

public void setBaseUrl(String baseUrl)
                throws MalformedURLException

Sets the base URL for the upload files link. Can throw an exception if format of the URL is invalid.

Parameters:

baseUrl - the base url including protocol and hostname.

Throws:

MalformedURLException - when baseUrl format is invalid.

getPath

public String getPath()

Gets the URL containing only the path (e.g. "/f/123456789") shared with users to let them upload files to the associated folder.

Returns:

the path of the URL for files upload.