com.box.sdk

Class BoxTermsOfService

Object

BoxResource

BoxTermsOfService

@BoxResourceType(value="terms_of_service")
public class BoxTermsOfService
extends BoxResource

Represents a custom Box Terms of Service object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BoxTermsOfService.Info Contains information about the terms of service.
static class	BoxTermsOfService.TermsOfServiceStatus Enumerates the possible status that a terms of service can have.
static class	BoxTermsOfService.TermsOfServiceType Enumerates the possible types of terms of service.

Field Summary

Fields

Modifier and Type	Field and Description
static URLTemplate	ALL_TERMS_OF_SERVICES_URL_TEMPLATE All Terms of Services URL Template.
static URLTemplate	TERMS_OF_SERVICE_URL_TEMPLATE Terms of Services URL Template.

Constructor Summary

Constructors

Constructor and Description
BoxTermsOfService(BoxAPIConnection api, String id) Constructs a BoxTermsOfService for a Box Enterprise with a given ID.

Method Summary

Modifier and Type	Method and Description
static BoxTermsOfService.Info	create(BoxAPIConnection api, BoxTermsOfService.TermsOfServiceStatus termsOfServiceStatus, BoxTermsOfService.TermsOfServiceType termsOfServiceType, String text) Creates a new Terms of Services.
static List<BoxTermsOfService.Info>	getAllTermsOfServices(BoxAPIConnection api) Retrieves a list of Terms of Services that belong to your Enterprise as an Iterable.
static List<BoxTermsOfService.Info>	getAllTermsOfServices(BoxAPIConnection api, BoxTermsOfService.TermsOfServiceType termsOfServiceType) Retrieves a list of Terms of Service that belong to your Enterprise as an Iterable.
BoxTermsOfService.Info	getInfo()
void	updateInfo(BoxTermsOfService.Info info) Updates the information about this terms of service with modified locally info.

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

TERMS_OF_SERVICE_URL_TEMPLATE

public static final URLTemplate TERMS_OF_SERVICE_URL_TEMPLATE

Terms of Services URL Template.

ALL_TERMS_OF_SERVICES_URL_TEMPLATE

public static final URLTemplate ALL_TERMS_OF_SERVICES_URL_TEMPLATE

All Terms of Services URL Template.

Constructor Detail

BoxTermsOfService

public BoxTermsOfService(BoxAPIConnection api,
                         String id)

Constructs a BoxTermsOfService for a Box Enterprise 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 BoxTermsOfService.Info create(BoxAPIConnection api,
                                            BoxTermsOfService.TermsOfServiceStatus termsOfServiceStatus,
                                            BoxTermsOfService.TermsOfServiceType termsOfServiceType,
                                            String text)

Creates a new Terms of Services.

Parameters:

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

termsOfServiceStatus - the current status of the terms of services. Set to "enabled" or "disabled".

termsOfServiceType - the scope of terms of service. Set to "external" or "managed".

text - the text field of terms of service containing terms of service agreement info.

Returns:

information about the Terms of Service created.

getAllTermsOfServices

public static List<BoxTermsOfService.Info> getAllTermsOfServices(BoxAPIConnection api)

Retrieves a list of Terms of Services that belong to your Enterprise as an Iterable.

Parameters:

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

Returns:

the Iterable of Terms of Service in your Enterprise.

getAllTermsOfServices

public static List<BoxTermsOfService.Info> getAllTermsOfServices(BoxAPIConnection api,
                                                                 BoxTermsOfService.TermsOfServiceType termsOfServiceType)

Retrieves a list of Terms of Service that belong to your Enterprise as an Iterable.

Parameters:

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

termsOfServiceType - the type of terms of service to be retrieved. Can be set to "managed" or "external"

Returns:

the Iterable of Terms of Service in an Enterprise that match the filter parameters.

updateInfo

public void updateInfo(BoxTermsOfService.Info info)

Updates the information about this terms of service with modified locally info. Only status and text can be modified.

Parameters:

info - the updated info.

getInfo

public BoxTermsOfService.Info getInfo()

Returns:

Gets information about this BoxTermsOfService.