com.box.sdk

Class BoxLegalHoldPolicy.Info

Object

BoxJSONObject

BoxResource.Info

BoxLegalHoldPolicy.Info

Enclosing class:

BoxLegalHoldPolicy

public class BoxLegalHoldPolicy.Info
extends BoxResource.Info

Contains information about the legal hold policy.

Constructor Summary

Constructors

Constructor and Description
Info() Constructs an empty Info object.
Info(String json) Constructs an Info object by parsing information from a JSON string.

Method Summary

Modifier and Type	Method and Description
int	getAssignmentCountFile()
int	getAssignmentCountFileVersion()
int	getAssignmentCountFolder()
int	getAssignmentCountUser()
Date	getCreatedAt()
BoxUser.Info	getCreatedBy()
Date	getDeletedAt()
String	getDescription()
Date	getFilterEndedAt()
Date	getFilterStartedAt()
Boolean	getIsOngoing()
Date	getModifiedAt()
String	getPolicyName()
String	getReleaseNotes()
BoxResource	getResource() Gets the resource associated with this Info.
String	getStatus() Status can be "active", "applying", "releasing" or "released".
void	setDescription(String description) Sets the policy's description.
void	setPolicyName(String policyName) Sets the policy's name.
void	setReleaseNotes(String releaseNotes) Sets the policy's release notes.

Methods inherited from class BoxResource.Info

getID

Methods inherited from class BoxJSONObject

clearPendingChanges, getJson, getPendingChanges, getPendingChangesAsJsonObject, getPendingJSONObject

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Info

public Info()

Constructs an empty Info object.

Info

public Info(String json)

Constructs an Info object by parsing information from a JSON string.

Parameters:

json - the JSON string to parse.

Method Detail

getResource

public BoxResource getResource()

Gets the resource associated with this Info.

Specified by:

getResource in class BoxResource.Info

Returns:

the associated resource.

getPolicyName

public String getPolicyName()

Returns:

the name of the policy.

setPolicyName

public void setPolicyName(String policyName)

Sets the policy's name.

Parameters:

policyName - the policy's new name.

getDescription

public String getDescription()

Returns:

the description of the policy.

setDescription

public void setDescription(String description)

Sets the policy's description.

Parameters:

description - the policy's new description.

getStatus

public String getStatus()

Status can be "active", "applying", "releasing" or "released".

Returns:

the status of the policy.

getAssignmentCountUser

public int getAssignmentCountUser()

Returns:

count of users this policy assigned to.

getAssignmentCountFolder

public int getAssignmentCountFolder()

Returns:

count of folders this policy assigned to.

getAssignmentCountFile

public int getAssignmentCountFile()

Returns:

count of files this policy assigned to.

getAssignmentCountFileVersion

public int getAssignmentCountFileVersion()

Returns:

count of file versions this policy assigned to.

getCreatedBy

public BoxUser.Info getCreatedBy()

Returns:

info about the user who created this policy.

getCreatedAt

public Date getCreatedAt()

Returns:

time the policy was created.

getModifiedAt

public Date getModifiedAt()

Returns:

time the policy was modified.

getDeletedAt

public Date getDeletedAt()

Returns:

time that the policy release request was sent.

getFilterStartedAt

public Date getFilterStartedAt()

Returns:

optional date filter applies to Custodian assignments only.

getFilterEndedAt

public Date getFilterEndedAt()

Returns:

optional date filter applies to Custodian assignments only.

getReleaseNotes

public String getReleaseNotes()

Returns:

notes around why the policy was released.

setReleaseNotes

public void setReleaseNotes(String releaseNotes)

Sets the policy's release notes.

Parameters:

releaseNotes - the policy's new release notes.

getIsOngoing

public Boolean getIsOngoing()

Returns:

boolean indicating whether the policy will continue applying to files based on events, indefinitely.