RetentionPolicy (Box Java SDK)

Object
- NullableFieldTracker
- - SerializableObject
  - - RetentionPolicyBase
    - - RetentionPolicyMini
      - RetentionPolicy

All Implemented Interfaces:

Serializable
```
public class RetentionPolicy
extends RetentionPolicyMini
```
A retention policy blocks permanent deletion of content for a specified amount of time. Admins can create retention policies and then later assign them to specific folders, metadata templates, or their entire enterprise. To use this feature, you must have the manage retention policies scope enabled for your API key via your application management console.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RetentionPolicy.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`RetentionPolicy.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`areOwnersNotified` Determines if owners and co-owners of items under the policy are notified when the retention duration is about to end.
`protected RetentionPolicyAssignmentCountsField`	`assignmentCounts` Counts the retention policy assignments for each item type.
`protected Boolean`	`canOwnerExtendRetention` Determines if the owner of items under the policy can extend the retention when the original retention duration is about to end.
`protected OffsetDateTime`	`createdAt` When the retention policy object was created.
`protected UserMini`	`createdBy`
`protected List<UserMini>`	`customNotificationRecipients` A list of users notified when the retention policy duration is about to end.
`protected String`	`description` The additional text description of the retention policy.
`protected OffsetDateTime`	`modifiedAt` When the retention policy object was last modified.
`protected EnumWrapper<RetentionPolicyPolicyTypeField>`	`policyType` The type of the retention policy.
`protected EnumWrapper<RetentionPolicyRetentionTypeField>`	`retentionType` Specifies the retention type:
`protected EnumWrapper<RetentionPolicyStatusField>`	`status` The status of the retention policy.

Fields inherited from class RetentionPolicyMini
dispositionAction, maxExtensionLength, policyName, retentionLength

Fields inherited from class RetentionPolicyBase
id, type

Fields inherited from class NullableFieldTracker
explicitlySetNullableFields

Constructor Summary

Constructors
Modifier Constructor and Description

protected RetentionPolicy(RetentionPolicy.Builder builder)

RetentionPolicy(String id)

Constructors
Modifier	Constructor and Description
`protected`	`RetentionPolicy(RetentionPolicy.Builder builder)`
	`RetentionPolicy(String id)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`Boolean`	`getAreOwnersNotified()`
`RetentionPolicyAssignmentCountsField`	`getAssignmentCounts()`
`Boolean`	`getCanOwnerExtendRetention()`
`OffsetDateTime`	`getCreatedAt()`
`UserMini`	`getCreatedBy()`
`List<UserMini>`	`getCustomNotificationRecipients()`
`String`	`getDescription()`
`OffsetDateTime`	`getModifiedAt()`
`EnumWrapper<RetentionPolicyPolicyTypeField>`	`getPolicyType()`
`EnumWrapper<RetentionPolicyRetentionTypeField>`	`getRetentionType()`
`EnumWrapper<RetentionPolicyStatusField>`	`getStatus()`
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class RetentionPolicyMini
getDispositionAction, getMaxExtensionLength, getPolicyName, getRetentionLength

Methods inherited from class RetentionPolicyBase
getId, getType

Methods inherited from class SerializableObject
getRawData, setRawData

Methods inherited from class NullableFieldTracker
getExplicitlySetNullableFields, isFieldExplicitlySet, markNullableFieldAsSet, markNullableFieldsAsSet

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - description
```
protected String description
```
    The additional text description of the retention policy.
  - policyType
```
protected EnumWrapper<RetentionPolicyPolicyTypeField> policyType
```
    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.
  - retentionType
```
protected EnumWrapper<RetentionPolicyRetentionTypeField> retentionType
```
    Specifies the retention type:
    * `modifiable`: You can modify the retention policy. For example, you can add or remove folders, shorten or lengthen the policy duration, or delete the assignment. Use this type if your retention policy is not related to any regulatory purposes.
    * `non-modifiable`: You 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. Use this type to ensure compliance with regulatory retention policies.
  - status
```
protected EnumWrapper<RetentionPolicyStatusField> status
```
    The status of the retention policy. The status of a policy will be `active`, unless explicitly retired by an administrator, in which case the status will be `retired`. Once a policy has been retired, it cannot become active again.
  - createdBy
```
protected UserMini createdBy
```
  - createdAt
```
protected OffsetDateTime createdAt
```
    When the retention policy object was created.
  - modifiedAt
```
protected OffsetDateTime modifiedAt
```
    When the retention policy object was last modified.
  - canOwnerExtendRetention
```
protected Boolean canOwnerExtendRetention
```
    Determines if the owner of items under the policy can extend the retention when the original retention duration is about to end.
  - areOwnersNotified
```
protected Boolean areOwnersNotified
```
    Determines if owners and co-owners of items under the policy are notified when the retention duration is about to end.
  - customNotificationRecipients
```
protected List<UserMini> customNotificationRecipients
```
    A list of users notified when the retention policy duration is about to end.
  - assignmentCounts
```
protected RetentionPolicyAssignmentCountsField assignmentCounts
```
    Counts the retention policy assignments for each item type.
- Constructor Detail
  - RetentionPolicy
```
public RetentionPolicy(String id)
```
  - RetentionPolicy
```
protected RetentionPolicy(RetentionPolicy.Builder builder)
```
- Method Detail
  - getDescription
```
public String getDescription()
```
  - getPolicyType
```
public EnumWrapper<RetentionPolicyPolicyTypeField> getPolicyType()
```
  - getRetentionType
```
public EnumWrapper<RetentionPolicyRetentionTypeField> getRetentionType()
```
  - getStatus
```
public EnumWrapper<RetentionPolicyStatusField> getStatus()
```
  - getCreatedBy
```
public UserMini getCreatedBy()
```
  - getCreatedAt
```
public OffsetDateTime getCreatedAt()
```
  - getModifiedAt
```
public OffsetDateTime getModifiedAt()
```
  - getCanOwnerExtendRetention
```
public Boolean getCanOwnerExtendRetention()
```
  - getAreOwnersNotified
```
public Boolean getAreOwnersNotified()
```
  - getCustomNotificationRecipients
```
public List<UserMini> getCustomNotificationRecipients()
```
  - getAssignmentCounts
```
public RetentionPolicyAssignmentCountsField getAssignmentCounts()
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class RetentionPolicyMini
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class RetentionPolicyMini
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class RetentionPolicyMini

Class RetentionPolicy

Nested Class Summary

Field Summary

Fields inherited from class RetentionPolicyMini

Fields inherited from class RetentionPolicyBase

Fields inherited from class NullableFieldTracker

Constructor Summary

Method Summary

Methods inherited from class RetentionPolicyMini

Methods inherited from class RetentionPolicyBase

Methods inherited from class SerializableObject

Methods inherited from class NullableFieldTracker

Methods inherited from class Object

Field Detail

description

policyType

retentionType

status

createdBy

createdAt

modifiedAt

canOwnerExtendRetention

areOwnersNotified

customNotificationRecipients

assignmentCounts

Constructor Detail

RetentionPolicy

RetentionPolicy

Method Detail

getDescription

getPolicyType

getRetentionType

getStatus

getCreatedBy

getCreatedAt

getModifiedAt

getCanOwnerExtendRetention

getAreOwnersNotified

getCustomNotificationRecipients

getAssignmentCounts

equals

hashCode

toString