com.box.sdk

Class BoxLegalHoldPolicy

Object

BoxResource

BoxLegalHoldPolicy

@BoxResourceType(value="legal_hold")
public class BoxLegalHoldPolicy
extends BoxResource

Represents a legal hold policy. Legal Hold Policy information describes the basic characteristics of the Policy, such as name, description, and filter dates.

See Also:

Box legal holds

Unless otherwise noted, the methods in this class can throw an unchecked {@link BoxAPIException} (unchecked meaning that the compiler won't force you to handle it) if an error occurs. If you wish to implement custom error handling for errors related to the Box REST API, you should capture this exception explicitly.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BoxLegalHoldPolicy.Info Contains information about the legal hold policy.

Field Summary

Fields

Modifier and Type	Field and Description
static URLTemplate	ALL_LEGAL_HOLD_URL_TEMPLATE All Legal Hold URL Template.
static URLTemplate	LEGAL_HOLD_ASSIGNMENTS_URL_TEMPLATE Legal Hold Assignments URL Template.
static URLTemplate	LEGAL_HOLD_URL_TEMPLATE Legal Hold URL Template.
static URLTemplate	LIST_OF_FILE_VERSION_HOLDS_URL_TEMPLATE List of File Version Holds URL Template.

Constructor Summary

Constructors

Constructor and Description
BoxLegalHoldPolicy(BoxAPIConnection api, String id) Constructs a BoxLegalHoldPolicy for a resource with a given ID.

Method Summary

Modifier and Type	Method and Description
BoxLegalHoldAssignment.Info	assignTo(BoxResource resource) Assigns this legal holds policy to the given box resource.
static BoxLegalHoldPolicy.Info	create(BoxAPIConnection api, String name) Creates a new Legal Hold Policy.
static BoxLegalHoldPolicy.Info	create(BoxAPIConnection api, String name, String description, Date filterStartedAt, Date filterEndedAt) Creates a new Legal Hold Policy.
static BoxLegalHoldPolicy.Info	createOngoing(BoxAPIConnection api, String name, String description) Creates a new ongoing Legal Hold Policy.
void	delete() Deletes the legal hold policy.
static Iterable<BoxLegalHoldPolicy.Info>	getAll(BoxAPIConnection api) Retrieves a list of Legal Hold Policies that belong to your Enterprise as an Iterable.
static Iterable<BoxLegalHoldPolicy.Info>	getAll(BoxAPIConnection api, String policyName, int limit, String... fields) Retrieves a list of Legal Hold Policies that belong to your Enterprise as an Iterable.
Iterable<BoxLegalHoldAssignment.Info>	getAssignments(String... fields) Returns iterable containing assignments for this single legal hold policy.
Iterable<BoxLegalHoldAssignment.Info>	getAssignments(String type, String id, int limit, String... fields) Returns iterable containing assignments for this single legal hold policy.
Iterable<BoxFileVersionLegalHold.Info>	getFileVersionHolds(int limit, String... fields) Returns iterable with all non-deleted file version legal holds for this legal hold policy.
Iterable<BoxFileVersionLegalHold.Info>	getFileVersionHolds(String... fields) Returns iterable with all non-deleted file version legal holds for this legal hold policy.
BoxLegalHoldPolicy.Info	getInfo(String... fields) Gets information about the Legal Hold.
void	updateInfo(BoxLegalHoldPolicy.Info info) Updates the information about this retention policy with modified locally info.

Methods inherited from class BoxResource

equals, getAPI, getID, getResourceType, hashCode

Methods inherited from class Object

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

Field Detail

LEGAL_HOLD_URL_TEMPLATE

public static final URLTemplate LEGAL_HOLD_URL_TEMPLATE

Legal Hold URL Template.

ALL_LEGAL_HOLD_URL_TEMPLATE

public static final URLTemplate ALL_LEGAL_HOLD_URL_TEMPLATE

All Legal Hold URL Template.

LEGAL_HOLD_ASSIGNMENTS_URL_TEMPLATE

public static final URLTemplate LEGAL_HOLD_ASSIGNMENTS_URL_TEMPLATE

Legal Hold Assignments URL Template.

LIST_OF_FILE_VERSION_HOLDS_URL_TEMPLATE

public static final URLTemplate LIST_OF_FILE_VERSION_HOLDS_URL_TEMPLATE

List of File Version Holds URL Template.

Constructor Detail

BoxLegalHoldPolicy

public BoxLegalHoldPolicy(BoxAPIConnection api,
                          String id)

Constructs a BoxLegalHoldPolicy for a resource with a given ID.

Parameters:

api - the API connection to be used by the resource.

id - the ID of the resource.

Method Detail

create

public static BoxLegalHoldPolicy.Info create(BoxAPIConnection api,
                                             String name)

Creates a new Legal Hold Policy.

Parameters:

api - the API connection to be used by the resource.

name - the name of Legal Hold Policy.

Returns:

information about the Legal Hold Policy created.

create

public static BoxLegalHoldPolicy.Info create(BoxAPIConnection api,
                                             String name,
                                             String description,
                                             Date filterStartedAt,
                                             Date filterEndedAt)

Creates a new Legal Hold Policy.

Parameters:

api - the API connection to be used by the resource.

name - the name of Legal Hold Policy.

description - the description of Legal Hold Policy.

filterStartedAt - optional date filter applies to Custodian assignments only.

filterEndedAt - optional date filter applies to Custodian assignments only.

Returns:

information about the Legal Hold Policy created.

createOngoing

public static BoxLegalHoldPolicy.Info createOngoing(BoxAPIConnection api,
                                                    String name,
                                                    String description)

Creates a new ongoing Legal Hold Policy.

Parameters:

api - the API connection to be used by the resource.

name - the name of Legal Hold Policy.

description - the description of Legal Hold Policy.

Returns:

information about the Legal Hold Policy created.

getAll

public static Iterable<BoxLegalHoldPolicy.Info> getAll(BoxAPIConnection api)

Retrieves a list of Legal Hold Policies that belong to your Enterprise as an Iterable.

Parameters:

api - api the API connection to be used by the resource.

Returns:

the Iterable of Legal Hold Policies in your Enterprise.

getAll

public static Iterable<BoxLegalHoldPolicy.Info> getAll(BoxAPIConnection api,
                                                       String policyName,
                                                       int limit,
                                                       String... fields)

Retrieves a list of Legal Hold Policies that belong to your Enterprise as an Iterable.

Parameters:

api - api the API connection to be used by the resource.

policyName - case insensitive prefix-match filter on Policy name.

limit - the limit of retrieved entries per page.

fields - the optional fields to retrieve.

Returns:

the Iterable of Legal Hold Policies in your Enterprise that match the filter parameters.

getInfo

public BoxLegalHoldPolicy.Info getInfo(String... fields)

Gets information about the Legal Hold.

Parameters:

fields - the fields to retrieve.

Returns:

information about this legal hold policy.

delete

public void delete()

Deletes the legal hold policy.

updateInfo

public void updateInfo(BoxLegalHoldPolicy.Info info)

Updates the information about this retention policy with modified locally info. Only policy_name, description and release_notes can be modified.

Parameters:

info - the updated info.

assignTo

public BoxLegalHoldAssignment.Info assignTo(BoxResource resource)

Assigns this legal holds policy to the given box resource. Currently only BoxFile, BoxFileVersion, BoxFolder and BoxUser are supported.

Parameters:

resource - the box resource to assign legal hold policy to.

Returns:

info about created legal hold policy assignment.

getAssignments

public Iterable<BoxLegalHoldAssignment.Info> getAssignments(String... fields)

Returns iterable containing assignments for this single legal hold policy.

Parameters:

fields - the fields to retrieve.

Returns:

an iterable containing assignments for this single legal hold policy.

getAssignments

public Iterable<BoxLegalHoldAssignment.Info> getAssignments(String type,
                                                            String id,
                                                            int limit,
                                                            String... fields)

Returns iterable containing assignments for this single legal hold policy. Parameters can be used to filter retrieved assignments.

Parameters:

type - filter assignments of this type only. Can be "file_version", "file", "folder", "user" or null if no type filter is necessary.

id - filter assignments to this ID only. Can be null if no id filter is necessary.

limit - the limit of entries per page. Default limit is 100.

fields - the fields to retrieve.

Returns:

an iterable containing assignments for this single legal hold policy.

getFileVersionHolds

public Iterable<BoxFileVersionLegalHold.Info> getFileVersionHolds(String... fields)

Returns iterable with all non-deleted file version legal holds for this legal hold policy.

Parameters:

fields - the fields to retrieve.

Returns:

an iterable containing file version legal holds info.

getFileVersionHolds

public Iterable<BoxFileVersionLegalHold.Info> getFileVersionHolds(int limit,
                                                                  String... fields)

Returns iterable with all non-deleted file version legal holds for this legal hold policy.

Parameters:

limit - the limit of entries per response. The default value is 100.

fields - the fields to retrieve.

Returns:

an iterable containing file version legal holds info.