com.box.sdk

Class RetentionPolicyParams

Object

RetentionPolicyParams

public class RetentionPolicyParams
extends Object

Optional parameters for creating an updating a Retention Policy.

See Also:

BoxRetentionPolicy

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()
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.

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.

getAreOwnersNotified

public boolean getAreOwnersNotified()

Returns:

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

getCustomNotificationRecipients

public List<BoxUser.Info> getCustomNotificationRecipients()

Returns:

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

setCanOwnerExtendRetention

public void setCanOwnerExtendRetention(boolean canOwnerExtendRetention)

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

Parameters:

canOwnerExtendRetention - The flag value.

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.

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