com.box.sdk

Class BoxRetentionPolicyAssignment

Object

BoxResource

BoxRetentionPolicyAssignment

@BoxResourceType(value="retention_policy_assignment")
public class BoxRetentionPolicyAssignment
extends BoxResource

Represents a retention policy assignment.

Unless otherwise noted, the methods in this class can throw an unchecked 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	BoxRetentionPolicyAssignment.Info Contains information about the retention policy.

Field Summary

Fields

Modifier and Type	Field and Description
static URLTemplate	ASSIGNMENTS_URL_TEMPLATE The URL template used for operation with retention policy assignments.
static URLTemplate	FILE_VERSIONS_UNDER_RETENTION_URL_TEMPLATE The URL template used for operation with file versions under retention with given retention policy assignment ID.
static URLTemplate	FILES_UNDER_RETENTION_URL_TEMPLATE The URL template used for operation with files under retention with given retention policy assignment ID.
static URLTemplate	RETENTION_POLICY_ASSIGNMENT_URL_TEMPLATE The URL template used for operation with retention policy assignment with given ID.
static String	TYPE_ENTERPRISE Type for enterprise policy assignment.
static String	TYPE_FOLDER Type for folder policy assignment.
static String	TYPE_METADATA Type for metadata policy assignment.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static BoxRetentionPolicyAssignment.Info	createAssignmentToEnterprise(BoxAPIConnection api, String policyID) Assigns retention policy with givenID to the enterprise.
static BoxRetentionPolicyAssignment.Info	createAssignmentToFolder(BoxAPIConnection api, String policyID, String folderID) Assigns retention policy with givenID to the folder.
static BoxRetentionPolicyAssignment.Info	createAssignmentToMetadata(BoxAPIConnection api, String policyID, String templateID, MetadataFieldFilter... filter) Assigns a retention policy to all items with a given metadata template, optionally matching on fields.
static BoxRetentionPolicyAssignment.Info	createAssignmentToMetadata(BoxAPIConnection api, String policyID, String templateID, String startDateField, MetadataFieldFilter... filter) Assigns a retention policy to all items with a given metadata template, optionally matching on fields.
void	delete() Deletes retention policy assignment.
Iterable<BoxFile.Info>	getFilesUnderRetention(int limit, String... fields) Retrieves all files under retention for assignment as Iterable.
Iterable<BoxFile.Info>	getFilesUnderRetention(String... fields) Retrieves all files under retention for assignment as Iterable.
Iterable<BoxFile.Info>	getFileVersionsUnderRetention(int limit, String... fields) Retrieves all file version under retention for assignment as Iterable.
Iterable<BoxFile.Info>	getFileVersionsUnderRetention(String... fields) Retrieves all file version under retention for assignment as Iterable.
BoxRetentionPolicyAssignment.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_FOLDER

public static final String TYPE_FOLDER

Type for folder policy assignment.

See Also:

Constant Field Values

TYPE_ENTERPRISE

public static final String TYPE_ENTERPRISE

Type for enterprise policy assignment.

See Also:

Constant Field Values

TYPE_METADATA

public static final String TYPE_METADATA

Type for metadata policy assignment.

See Also:

Constant Field Values

ASSIGNMENTS_URL_TEMPLATE

public static final URLTemplate ASSIGNMENTS_URL_TEMPLATE

The URL template used for operation with retention policy assignments.

RETENTION_POLICY_ASSIGNMENT_URL_TEMPLATE

public static final URLTemplate RETENTION_POLICY_ASSIGNMENT_URL_TEMPLATE

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

FILES_UNDER_RETENTION_URL_TEMPLATE

public static final URLTemplate FILES_UNDER_RETENTION_URL_TEMPLATE

The URL template used for operation with files under retention with given retention policy assignment ID.

FILE_VERSIONS_UNDER_RETENTION_URL_TEMPLATE

public static final URLTemplate FILE_VERSIONS_UNDER_RETENTION_URL_TEMPLATE

The URL template used for operation with file versions under retention with given retention policy assignment ID.

Constructor Detail

BoxRetentionPolicyAssignment

public BoxRetentionPolicyAssignment(BoxAPIConnection api,
                                    String id)

Constructs a BoxResource 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

createAssignmentToEnterprise

public static BoxRetentionPolicyAssignment.Info createAssignmentToEnterprise(BoxAPIConnection api,
                                                                             String policyID)

Assigns retention policy with givenID to the enterprise.

Parameters:

api - the API connection to be used by the created assignment.

policyID - id of the assigned retention policy.

Returns:

info about created assignment.

createAssignmentToFolder

public static BoxRetentionPolicyAssignment.Info createAssignmentToFolder(BoxAPIConnection api,
                                                                         String policyID,
                                                                         String folderID)

Assigns retention policy with givenID to the folder.

Parameters:

api - the API connection to be used by the created assignment.

policyID - id of the assigned retention policy.

folderID - id of the folder to assign policy to.

Returns:

info about created assignment.

createAssignmentToMetadata

public static BoxRetentionPolicyAssignment.Info createAssignmentToMetadata(BoxAPIConnection api,
                                                                           String policyID,
                                                                           String templateID,
                                                                           MetadataFieldFilter... filter)

Assigns a retention policy to all items with a given metadata template, optionally matching on fields.

Parameters:

api - the API connection to be used by the created assignment.

policyID - id of the assigned retention policy.

templateID - the ID of the metadata template to assign the policy to.

filter - optional fields to match against in the metadata template.

Returns:

info about the created assignment.

createAssignmentToMetadata

public static BoxRetentionPolicyAssignment.Info createAssignmentToMetadata(BoxAPIConnection api,
                                                                           String policyID,
                                                                           String templateID,
                                                                           String startDateField,
                                                                           MetadataFieldFilter... filter)

Assigns a retention policy to all items with a given metadata template, optionally matching on fields.

Parameters:

api - the API connection to be used by the created assignment.

policyID - id of the assigned retention policy.

templateID - the ID of the metadata template to assign the policy to.

startDateField - The date the retention policy assignment begins. This field can be a date field's metadata attribute key id.

filter - optional fields to match against in the metadata template.

Returns:

info about the created assignment.

getInfo

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

Parameters:

fields - the fields to retrieve.

Returns:

information about this retention policy assignment.

getFilesUnderRetention

public Iterable<BoxFile.Info> getFilesUnderRetention(String... fields)

Retrieves all files under retention for assignment as Iterable. Default limit is 100

Parameters:

fields - the fields to retrieve.

Returns:

an iterable contains information about all files under retentions as Iterable.

getFilesUnderRetention

public Iterable<BoxFile.Info> getFilesUnderRetention(int limit,
                                                     String... fields)

Retrieves all files under retention for assignment as Iterable.

Parameters:

limit - the limit of retrieved entries per page.

fields - the fields to retrieve.

Returns:

an iterable contains information about all files under retentions as Iterable.

getFileVersionsUnderRetention

public Iterable<BoxFile.Info> getFileVersionsUnderRetention(String... fields)

Retrieves all file version under retention for assignment as Iterable. Default limit is 100.

Parameters:

fields - the fields to retrieve.

Returns:

an iterable contains information about all file versions under retentions as Iterable.

getFileVersionsUnderRetention

public Iterable<BoxFile.Info> getFileVersionsUnderRetention(int limit,
                                                            String... fields)

Retrieves all file version under retention for assignment as Iterable.

Parameters:

limit - the limit of retrieved entries per page.

fields - the fields to retrieve.

Returns:

an iterable contains information about all file versions under retentions as Iterable.

delete

public void delete()

Deletes retention policy assignment.