com.box.sdk

Class BoxStoragePolicy

Object

BoxResource

BoxStoragePolicy

@BoxResourceType(value="storage_policy")
public class BoxStoragePolicy
extends BoxResource

Represents a BoxStoragePolicy.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BoxStoragePolicy.Info Contains information about the BoxStoragePolicy.

Field Summary

Fields

Modifier and Type	Field and Description
static URLTemplate	STORAGE_POLICY_URL_TEMPLATE Storage Policies URL Template.
static URLTemplate	STORAGE_POLICY_WITH_ID_URL_TEMPLATE Storage Policies URL Template.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
BoxStoragePolicyAssignment.Info	assign(String userID) Checks if there is already a Storage Policy Assignment and creates one if one does not exist.
static Iterable<BoxStoragePolicy.Info>	getAll(BoxAPIConnection api, int limit, String... fields) Returns all BoxStoragePolicy with specified fields.
static Iterable<BoxStoragePolicy.Info>	getAll(BoxAPIConnection api, String... fields) Returns all BoxStoragePolicy with specified fields.
BoxStoragePolicy.Info	getInfo(String... fields) Gets information for a Box Storage Policy with optional 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

STORAGE_POLICY_URL_TEMPLATE

public static final URLTemplate STORAGE_POLICY_URL_TEMPLATE

Storage Policies URL Template.

STORAGE_POLICY_WITH_ID_URL_TEMPLATE

public static final URLTemplate STORAGE_POLICY_WITH_ID_URL_TEMPLATE

Storage Policies URL Template.

Constructor Detail

BoxStoragePolicy

public BoxStoragePolicy(BoxAPIConnection api,
                        String id)

Constructs a BoxStoragePolicy with a given ID.

Parameters:

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

id - the ID of the BoxStoragePolicy.

Method Detail

getAll

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

Returns all BoxStoragePolicy with specified fields.

Parameters:

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

fields - the fields to retrieve.

Returns:

an iterable with all the storage policies met search conditions.

getAll

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

Returns all BoxStoragePolicy with specified fields.

Parameters:

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

limit - the limit of items per single response. The default is 100.

fields - the fields to retrieve.

Returns:

an iterable with all the storage policies met search conditions.

getInfo

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

Gets information for a Box Storage Policy with optional fields.

Parameters:

fields - the fields to retrieve.

Returns:

info about this item containing only the specified fields, including storage policy.

assign

public BoxStoragePolicyAssignment.Info assign(String userID)

Checks if there is already a Storage Policy Assignment and creates one if one does not exist.

Parameters:

userID - the ID of the user you want to assign the Storage Policy to.

Returns:

information about this BoxStoragePolicyAssignment.