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
boolean	getAreOwnersNotified() Gets the flag to denote that owners and co-owners of a retained file will get notified when near expiration.
boolean	getCanOwnerExtendRetention() Gets the flag to denote that the owner of a retained file can extend the retention when near expiration.
Date	getCreatedAt() Gets the time that the retention policy was created.
BoxUser.Info	getCreatedBy() Gets info about the user created the retention policy.
List<BoxUser.Info>	getCustomNotificationRecipients() Gets the list of users to be notified of a retained file when near expiration.
String	getDescription() Gets the additional text desription of 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.
RetentionPolicyParams.RetentionType	getRetentionType()
String	getStatus() Gets the status of the retention policy.
void	setDescription(String description) Set the additional text desription of the retention policy.
void	setDispositionAction(String dispositionAction) Set the action to take when retention period ends.
void	setPolicyName(String policyName) Update the policy name to a new value.
void	setRetentionLength(int retentionLength)
void	setRetentionTypeToNonModifiable() It is not possible to set retention type to `modifiable` once it was set to `non-modifiable`.
void	setStatus(String status) Set the policy status.

Methods inherited from class BoxResource.Info

getID

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

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.

setPolicyName

public void setPolicyName(String policyName)

Update the policy name to a new value.

Parameters:

policyName - the new policy name.

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.

setRetentionLength

public void setRetentionLength(int retentionLength)

Parameters:

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

setDispositionAction

public void setDispositionAction(String dispositionAction)

Set the action to take when retention period ends.

Parameters:

dispositionAction - the new action.

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.

setStatus

public void setStatus(String status)

Set the policy status.

Parameters:

status - the new status value.

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.

getCanOwnerExtendRetention

public boolean getCanOwnerExtendRetention()

Gets the flag to denote that the owner of a retained file can extend the retention when near expiration.

Returns:

the boolean flag.

getAreOwnersNotified

public boolean getAreOwnersNotified()

Gets the flag to denote that owners and co-owners of a retained file will get notified when near expiration.

Returns:

the boolean flag.

getDescription

public String getDescription()

Gets the additional text desription of the retention policy.

Returns:

the additional text desription of the retention policy

setDescription

public void setDescription(String description)

Set the additional text desription of the retention policy.

Parameters:

description - the new text desription of the retention policy

getRetentionType

public RetentionPolicyParams.RetentionType getRetentionType()

Returns:

retention type. It can be one of values: `modifiable` or `non-modifiable`. `modifiable` means that you can modify the retention policy. For example, you can add or remove folders, shorten or lengthen the policy duration, or delete the assignment. `non-modifiable` means that can modify the retention policy only in a limited way: add a folder, lengthen the duration, retire the policy, change the disposition action or notification settings. You cannot perform other actions, such as deleting the assignment or shortening the policy duration.

setRetentionTypeToNonModifiable

public void setRetentionTypeToNonModifiable()

It is not possible to set retention type to `modifiable` once it was set to `non-modifiable`.

getCustomNotificationRecipients

public List<BoxUser.Info> getCustomNotificationRecipients()

Gets the list of users to be notified of a retained file when near expiration.

Returns:

the list of users to be notified.