com.box.sdk

Class BoxLegalHoldAssignment

Object

BoxResource

BoxLegalHoldAssignment

@BoxResourceType(value="legal_hold_assignment")
public class BoxLegalHoldAssignment
extends BoxResource

Represents a legal hold policy assignment. Legal hold assignments are used to assign legal hold policies to custodians, folders, files, or file versions.

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	BoxLegalHoldAssignment.Info Contains information about the legal hold policy.

Field Summary

Fields

Modifier and Type	Field and Description
static URLTemplate	ASSIGNMENTS_URL_TEMPLATE The URL template used for operation with legal hold policy assignments.
static URLTemplate	LEGAL_HOLD_ASSIGNMENT_URL_TEMPLATE The URL template used for operation with legal hold policy assignment with given ID.
static String	TYPE_FILE Used to assign legal hold policy to file.
static String	TYPE_FILE_VERSION Used to assign legal hold policy to file version.
static String	TYPE_FOLDER Used to assign legal hold policy to folder.
static String	TYPE_USER Used to assign legal hold policy to user.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static BoxLegalHoldAssignment.Info	create(BoxAPIConnection api, String policyID, String resourceType, String resourceID) Creates new legal hold policy assignment.
void	delete() Deletes the legal hold policy assignment.
BoxLegalHoldAssignment.Info	getInfo(String... fields)

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

TYPE_FILE_VERSION

public static final String TYPE_FILE_VERSION

Used to assign legal hold policy to file version.

TYPE_FILE

public static final String TYPE_FILE

Used to assign legal hold policy to file.

TYPE_FOLDER

public static final String TYPE_FOLDER

Used to assign legal hold policy to folder.

TYPE_USER

public static final String TYPE_USER

Used to assign legal hold policy to user.

ASSIGNMENTS_URL_TEMPLATE

public static final URLTemplate ASSIGNMENTS_URL_TEMPLATE

The URL template used for operation with legal hold policy assignments.

LEGAL_HOLD_ASSIGNMENT_URL_TEMPLATE

public static final URLTemplate LEGAL_HOLD_ASSIGNMENT_URL_TEMPLATE

The URL template used for operation with legal hold policy assignment with given ID.

Constructor Detail

BoxLegalHoldAssignment

public BoxLegalHoldAssignment(BoxAPIConnection api,
                              String id)

Constructs a BoxLegalHoldAssignment 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 BoxLegalHoldAssignment.Info create(BoxAPIConnection api,
                                                 String policyID,
                                                 String resourceType,
                                                 String resourceID)

Creates new legal hold policy assignment.

Parameters:

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

policyID - ID of policy to create assignment for.

resourceType - type of target resource. Can be 'file_version', 'file', 'folder', or 'user'.

resourceID - ID of the target resource.

Returns:

info about created legal hold policy assignment.

delete

public void delete()

Deletes the legal hold policy assignment.

getInfo

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

Parameters:

fields - the fields to retrieve.

Returns:

information about this retention policy.