LegalHoldPolicy (Box Java SDK)

Object
- NullableFieldTracker
- - SerializableObject
  - - LegalHoldPolicyMini
    - - LegalHoldPolicy

All Implemented Interfaces:

Serializable
```
public class LegalHoldPolicy
extends LegalHoldPolicyMini
```
Legal Hold Policy information describes the basic characteristics of the Policy, such as name, description, and filter dates.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class LegalHoldPolicy.Builder

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected LegalHoldPolicyAssignmentCountsField`	`assignmentCounts` Counts of assignments within a legal hold policy by item type.
`protected OffsetDateTime`	`createdAt` When the legal hold policy object was created.
`protected UserMini`	`createdBy`
`protected OffsetDateTime`	`deletedAt` When the policy release request was sent.
`protected String`	`description` Description of the legal hold policy.
`protected OffsetDateTime`	`filterEndedAt` User-specified, optional date filter applies to Custodian assignments only.
`protected OffsetDateTime`	`filterStartedAt` User-specified, optional date filter applies to Custodian assignments only.
`protected OffsetDateTime`	`modifiedAt` When the legal hold policy object was modified.
`protected String`	`policyName` Name of the legal hold policy.
`protected String`	`releaseNotes` Optional notes about why the policy was created.
`protected EnumWrapper<LegalHoldPolicyStatusField>`	`status` Possible values: * 'active' - the policy is not in a transition state.

Fields inherited from class LegalHoldPolicyMini
id, type

Fields inherited from class NullableFieldTracker
explicitlySetNullableFields

Constructor Summary

Constructors
Modifier Constructor and Description

protected LegalHoldPolicy(LegalHoldPolicy.Builder builder)

LegalHoldPolicy(String id)

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`LegalHoldPolicyAssignmentCountsField`	`getAssignmentCounts()`
`OffsetDateTime`	`getCreatedAt()`
`UserMini`	`getCreatedBy()`
`OffsetDateTime`	`getDeletedAt()`
`String`	`getDescription()`
`OffsetDateTime`	`getFilterEndedAt()`
`OffsetDateTime`	`getFilterStartedAt()`
`OffsetDateTime`	`getModifiedAt()`
`String`	`getPolicyName()`
`String`	`getReleaseNotes()`
`EnumWrapper<LegalHoldPolicyStatusField>`	`getStatus()`
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class LegalHoldPolicyMini
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
  - policyName
```
protected String policyName
```
    Name of the legal hold policy.
  - description
```
protected String description
```
    Description of the legal hold policy. Optional property with a 500 character limit.
  - status
```
protected EnumWrapper<LegalHoldPolicyStatusField> status
```
    Possible values: * 'active' - the policy is not in a transition state. * 'applying' - that the policy is in the process of being applied. * 'releasing' - that the process is in the process of being released. * 'released' - the policy is no longer active.
  - assignmentCounts
```
protected LegalHoldPolicyAssignmentCountsField assignmentCounts
```
    Counts of assignments within a legal hold policy by item type.
  - createdBy
```
protected UserMini createdBy
```
  - createdAt
```
protected OffsetDateTime createdAt
```
    When the legal hold policy object was created.
  - modifiedAt
```
protected OffsetDateTime modifiedAt
```
    When the legal hold policy object was modified. Does not update when assignments are added or removed.
  - deletedAt
```
protected OffsetDateTime deletedAt
```
    When the policy release request was sent. (Because it can take time for a policy to fully delete, this isn't quite the same time that the policy is fully deleted).
    If `null`, the policy was not deleted.
  - filterStartedAt
```
protected OffsetDateTime filterStartedAt
```
    User-specified, optional date filter applies to Custodian assignments only.
  - filterEndedAt
```
protected OffsetDateTime filterEndedAt
```
    User-specified, optional date filter applies to Custodian assignments only.
  - releaseNotes
```
protected String releaseNotes
```
    Optional notes about why the policy was created.
- Constructor Detail
  - LegalHoldPolicy
```
public LegalHoldPolicy(String id)
```
  - LegalHoldPolicy
```
protected LegalHoldPolicy(LegalHoldPolicy.Builder builder)
```
- Method Detail
  - getPolicyName
```
public String getPolicyName()
```
  - getDescription
```
public String getDescription()
```
  - getStatus
```
public EnumWrapper<LegalHoldPolicyStatusField> getStatus()
```
  - getAssignmentCounts
```
public LegalHoldPolicyAssignmentCountsField getAssignmentCounts()
```
  - getCreatedBy
```
public UserMini getCreatedBy()
```
  - getCreatedAt
```
public OffsetDateTime getCreatedAt()
```
  - getModifiedAt
```
public OffsetDateTime getModifiedAt()
```
  - getDeletedAt
```
public OffsetDateTime getDeletedAt()
```
  - getFilterStartedAt
```
public OffsetDateTime getFilterStartedAt()
```
  - getFilterEndedAt
```
public OffsetDateTime getFilterEndedAt()
```
  - getReleaseNotes
```
public String getReleaseNotes()
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class LegalHoldPolicyMini
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class LegalHoldPolicyMini
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class LegalHoldPolicyMini

Class LegalHoldPolicy

Nested Class Summary

Field Summary

Fields inherited from class LegalHoldPolicyMini

Fields inherited from class NullableFieldTracker

Constructor Summary

Method Summary

Methods inherited from class LegalHoldPolicyMini

Methods inherited from class SerializableObject

Methods inherited from class NullableFieldTracker

Methods inherited from class Object

Field Detail

policyName

description

status

assignmentCounts

createdBy

createdAt

modifiedAt

deletedAt

filterStartedAt

filterEndedAt

releaseNotes

Constructor Detail

LegalHoldPolicy

LegalHoldPolicy

Method Detail

getPolicyName

getDescription

getStatus

getAssignmentCounts

getCreatedBy

getCreatedAt

getModifiedAt

getDeletedAt

getFilterStartedAt

getFilterEndedAt

getReleaseNotes

equals

hashCode

toString