com.box.sdk

Class BoxRetentionPolicy.Info

Object

BoxJSONObject

BoxResource.Info

BoxRetentionPolicy.Info

Enclosing class:

BoxRetentionPolicy

public class BoxRetentionPolicy.Info
extends BoxResource.Info

Contains information about the retention policy.

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
Date	getCreatedAt() Gets the time that the retention policy was created.
BoxUser.Info	getCreatedBy() Gets info about the user created the retention policy.
String	getDispositionAction() Gets the disposition action of the retention policy.
Date	getModifiedAt() Gets the time that the retention policy was last modified.
String	getPolicyName() Gets the name given to the retention policy.
String	getPolicyType() Gets the type of the retention policy.
BoxResource	getResource() Gets the resource associated with this Info.
int	getRetentionLength() Gets the length of the retention policy.
String	getStatus() Gets the status of the retention policy.

Methods inherited from class BoxResource.Info

getID

Methods inherited from class BoxJSONObject

clearPendingChanges, 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 BoxResource getResource()

Gets the resource associated with this Info.

Specified by:

getResource in class BoxResource.Info

Returns:

the associated resource.

getPolicyName

public String getPolicyName()

Gets the name given to the retention policy.

Returns:

name given to the retention policy.

getPolicyType

public String getPolicyType()

Gets the type of the retention policy. A retention policy type can either be "finite", where a specific amount of time to retain the content is known upfront, or "indefinite", where the amount of time to retain the content is still unknown.

Returns:

the type of the retention policy.

getRetentionLength

public int getRetentionLength()

Gets the length of the retention policy. This length specifies the duration in days that the retention policy will be active for after being assigned to content.

Returns:

the length of the retention policy.

getDispositionAction

public String getDispositionAction()

Gets the disposition action of the retention policy. This action can be "permanently_delete", or "remove_retention".

Returns:

the disposition action of the retention policy.

getStatus

public String getStatus()

Gets the status of the retention policy. The status can be "active" or "retired".

Returns:

the status of the retention policy.

getCreatedBy

public BoxUser.Info getCreatedBy()

Gets info about the user created the retention policy.

Returns:

info about the user created the retention policy.

getCreatedAt

public Date getCreatedAt()

Gets the time that the retention policy was created.

Returns:

the time that the retention policy was created.

getModifiedAt

public Date getModifiedAt()

Gets the time that the retention policy was last modified.

Returns:

the time that the retention policy was last modified.