com.box.sdk

Class BoxFileVersionRetention

Object

BoxResource

BoxFileVersionRetention

@BoxResourceType(value="file_version_retention")
public class BoxFileVersionRetention
extends BoxResource

Represents a file version retention. A retention policy blocks permanent deletion of content for a specified amount of time. Admins can apply policies to specified folders, or an entire enterprise. A file version retention is a record for a retained file version.

See Also:

Box file version retention

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	BoxFileVersionRetention.Info Contains information about the retention policy.
static class	BoxFileVersionRetention.QueryFilter Represents possible query filters for "Get File Version Retentions" function.

Field Summary

Fields

Modifier and Type	Field and Description
static URLTemplate	ALL_RETENTIONS_URL_TEMPLATE The URL template used for operation with file version retentions.
static URLTemplate	RETENTION_URL_TEMPLATE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static Iterable<BoxFileVersionRetention.Info>	getAll(BoxAPIConnection api, String... fields) Retrieves all file version retentions.
BoxFileVersionRetention.Info	getInfo(String... fields)
static Iterable<BoxFileVersionRetention.Info>	getRetentions(BoxAPIConnection api, BoxFileVersionRetention.QueryFilter filter, String... fields) Retrieves all file version retentions matching given filters as an Iterable.

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

RETENTION_URL_TEMPLATE

public static final URLTemplate RETENTION_URL_TEMPLATE

See Also:

getInfo(String...)

ALL_RETENTIONS_URL_TEMPLATE

public static final URLTemplate ALL_RETENTIONS_URL_TEMPLATE

The URL template used for operation with file version retentions.

Constructor Detail

BoxFileVersionRetention

public BoxFileVersionRetention(BoxAPIConnection api,
                               String id)

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

getAll

public static Iterable<BoxFileVersionRetention.Info> getAll(BoxAPIConnection api,
                                                            String... fields)

Retrieves all file version retentions.

Parameters:

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

fields - the fields to retrieve.

Returns:

an iterable contains information about all file version retentions.

getRetentions

public static Iterable<BoxFileVersionRetention.Info> getRetentions(BoxAPIConnection api,
                                                                   BoxFileVersionRetention.QueryFilter filter,
                                                                   String... fields)

Retrieves all file version retentions matching given filters as an Iterable.

Parameters:

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

filter - filters for the query stored in QueryFilter object.

fields - the fields to retrieve.

Returns:

an iterable contains information about all file version retentions matching given filter.

getInfo

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

Parameters:

fields - the fields to retrieve.

Returns:

information about this retention policy.