com.box.sdk

Class RetentionPolicyParams

Object

RetentionPolicyParams

public class RetentionPolicyParams
extends Object

Optional parameters for creating an updating a Retention Policy.

See Also:

BoxRetentionPolicy

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RetentionPolicyParams.RetentionType The type of retention.

Constructor Summary

Constructors

Constructor and Description
RetentionPolicyParams() Creates optional retention policy params with default values.

Method Summary

Modifier and Type	Method and Description
void	addCustomNotificationRecipient(BoxUser user) Add a user to the list of people to notify when the retention period is ending.
void	addCustomNotificationRecipient(String userID) Add a user by ID to the list of people to notify when the retention period is ending.
boolean	getAreOwnersNotified()
boolean	getCanOwnerExtendRetention()
List<BoxUser.Info>	getCustomNotificationRecipients()
String	getDescription()
RetentionPolicyParams.RetentionType	getRetentionType()
void	setAreOwnersNotified(boolean areOwnersNotified) Set the flag denoting whether owners and co-owners are notified when the retention period is ending.
void	setCanOwnerExtendRetention(boolean canOwnerExtendRetention) Set the flag denoting whether the owner can extend the retentiion.
void	setCustomNotificationRecipients(List<BoxUser.Info> customNotificationRecipients) Set the list of extra users to notify when the retention period is ending.
void	setDescription(String description) Set additional text description of the retention policy.
void	setRetentionType(RetentionPolicyParams.RetentionType retentionType)

Methods inherited from class Object

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

Constructor Detail

RetentionPolicyParams

public RetentionPolicyParams()

Creates optional retention policy params with default values.

Method Detail

getCanOwnerExtendRetention

public boolean getCanOwnerExtendRetention()

Returns:

the flag denoting whether the owner can extend the retention.

setCanOwnerExtendRetention

public void setCanOwnerExtendRetention(boolean canOwnerExtendRetention)

Set the flag denoting whether the owner can extend the retentiion.

Parameters:

canOwnerExtendRetention - The flag value.

getAreOwnersNotified

public boolean getAreOwnersNotified()

Returns:

the flag denoting whether owners and co-onwers are notified when the retention period is ending.

setAreOwnersNotified

public void setAreOwnersNotified(boolean areOwnersNotified)

Set the flag denoting whether owners and co-owners are notified when the retention period is ending.

Parameters:

areOwnersNotified - The flag value.

getDescription

public String getDescription()

Returns:

The additional text description 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.

setRetentionType

public void setRetentionType(RetentionPolicyParams.RetentionType retentionType)

Parameters:

retentionType - The retention type: `modifiable` or `non-modifiable`.

setDescription

public void setDescription(String description)

Set additional text description of the retention policy.

Parameters:

description - The additional text description of the retention policy.

getCustomNotificationRecipients

public List<BoxUser.Info> getCustomNotificationRecipients()

Returns:

the list of extra users to notify when the retention period is ending.

setCustomNotificationRecipients

public void setCustomNotificationRecipients(List<BoxUser.Info> customNotificationRecipients)

Set the list of extra users to notify when the retention period is ending.

Parameters:

customNotificationRecipients - The list of users.

addCustomNotificationRecipient

public void addCustomNotificationRecipient(String userID)

Add a user by ID to the list of people to notify when the retention period is ending.

Parameters:

userID - The ID of the user to add to the list.

addCustomNotificationRecipient

public void addCustomNotificationRecipient(BoxUser user)

Add a user to the list of people to notify when the retention period is ending.

Parameters:

user - The info of the user to add to the list