com.box.sdk

Class BoxMetadataCascadePolicy

Object

BoxResource

BoxMetadataCascadePolicy

@BoxResourceType(value="metadata_cascade_policy")
public class BoxMetadataCascadePolicy
extends BoxResource

Represents a Metadata Cascade Policy.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BoxMetadataCascadePolicy.Info Contains information about a BoxMetadataCascadePolicy.

Field Summary

Fields

Modifier and Type	Field and Description
static URLTemplate	FORCE_METADATA_CASCADE_POLICIES_URL_TEMPLATE Force Metadata Cascade Policies URL.
static URLTemplate	GET_ALL_METADATA_CASCADE_POLICIES_URL_TEMPLATE Get All Metadata Cascade Policies URL.
static URLTemplate	METADATA_CASCADE_POLICIES_URL_TEMPLATE Metadata Cascade Policies URL.

Constructor Summary

Constructors

Constructor and Description
BoxMetadataCascadePolicy(BoxAPIConnection api, String id) Constructs a BoxMetadataCascadePolicy for a metadata cascade policy with a given ID.

Method Summary

Modifier and Type	Method and Description
static BoxMetadataCascadePolicy.Info	create(BoxAPIConnection api, String folderID, String scope, String templateKey) Creates a new Metadata Cascade Policy on a folder.
void	delete() Deletes the metadata cascade policy.
void	forceApply(String conflictResolution) If a policy already exists on a folder, this will apply that policy to all existing files and sub folders within the target folder.
static Iterable<BoxMetadataCascadePolicy.Info>	getAll(BoxAPIConnection api, String folderID, String... fields) Retrieves list of Box Metadata Cascade Policies that belong to your Enterprise as an Iterable.
static Iterable<BoxMetadataCascadePolicy.Info>	getAll(BoxAPIConnection api, String folderID, String ownerEnterpriseID, int limit, String... fields) Retrieves list of Box Metadata Cascade Policies that belong to your Enterprise as an Iterable.
BoxMetadataCascadePolicy.Info	getInfo(String... fields) Returns the information for a specific BoxMetadataCascadePolicy.

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

GET_ALL_METADATA_CASCADE_POLICIES_URL_TEMPLATE

public static final URLTemplate GET_ALL_METADATA_CASCADE_POLICIES_URL_TEMPLATE

Get All Metadata Cascade Policies URL.

METADATA_CASCADE_POLICIES_URL_TEMPLATE

public static final URLTemplate METADATA_CASCADE_POLICIES_URL_TEMPLATE

Metadata Cascade Policies URL.

FORCE_METADATA_CASCADE_POLICIES_URL_TEMPLATE

public static final URLTemplate FORCE_METADATA_CASCADE_POLICIES_URL_TEMPLATE

Force Metadata Cascade Policies URL.

Constructor Detail

BoxMetadataCascadePolicy

public BoxMetadataCascadePolicy(BoxAPIConnection api,
                                String id)

Constructs a BoxMetadataCascadePolicy for a metadata cascade policy with a given ID.

Parameters:

api - the API connection used to make the request.

id - the ID of the metadata cascade policy.

Method Detail

getAll

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

Retrieves list of Box Metadata Cascade Policies that belong to your Enterprise as an Iterable.

Parameters:

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

folderID - the ID of the folder to retrieve cascade policies for.

fields - optional fields to retrieve for cascade policies.

Returns:

the Iterable of Box Metadata Cascade Policies in your enterprise.

getAll

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

Retrieves list of Box Metadata Cascade Policies that belong to your Enterprise as an Iterable.

Parameters:

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

folderID - the ID of the folder to retrieve cascade policies for.

ownerEnterpriseID - the ID of the enterprise to retrieve Metadata Cascade Policies for.

limit - the number of entries for cascade policies to retrieve.

fields - optional fields to retrieve for cascade policies.

Returns:

the Iterable of Box Metadata Cascade Policies in your enterprise.

create

public static BoxMetadataCascadePolicy.Info create(BoxAPIConnection api,
                                                   String folderID,
                                                   String scope,
                                                   String templateKey)

Creates a new Metadata Cascade Policy on a folder.

Parameters:

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

folderID - the ID of the folder to create a metadata cascade policy on.

scope - the scope of the metadata cascade policy.

templateKey - the key of the template.

Returns:

information about the Metadata Cascade Policy.

getInfo

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

Returns the information for a specific BoxMetadataCascadePolicy.

Parameters:

fields - the fields to retrieve.

Returns:

the information about this metadata cascade policy.

forceApply

public void forceApply(String conflictResolution)

If a policy already exists on a folder, this will apply that policy to all existing files and sub folders within the target folder.

Parameters:

conflictResolution - the desired behavior for conflict-resolution. Set to either none or overwrite.

delete

public void delete()

Deletes the metadata cascade policy.