FolderFull (Box Java SDK)

Object
- NullableFieldTracker
- - SerializableObject
  - - FolderBase
    - - FolderMini
      - Folder
        
        FolderFull

All Implemented Interfaces:

Serializable
```
public class FolderFull
extends Folder
```
A full representation of a folder, as can be returned from any folder API endpoints by default.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`FolderFull.AllowedInviteeRolesDeserializer`
`static class`	`FolderFull.AllowedInviteeRolesSerializer`
`static class`	`FolderFull.AllowedSharedLinkAccessLevelsDeserializer`
`static class`	`FolderFull.AllowedSharedLinkAccessLevelsSerializer`
`static class`	`FolderFull.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<EnumWrapper<FolderFullAllowedInviteeRolesField>>`	`allowedInviteeRoles` A list of the types of roles that user can be invited at when sharing this folder.
`protected List<EnumWrapper<FolderFullAllowedSharedLinkAccessLevelsField>>`	`allowedSharedLinkAccessLevels` The shared link access levels the authenticated user is allowed to use when creating or updating a shared link for this folder.
`protected Boolean`	`canNonOwnersInvite`
`protected Boolean`	`canNonOwnersViewCollaborators` Specifies if collaborators who are not owners of this folder are restricted from viewing other collaborations on this folder.
`protected FolderFullClassificationField`	`classification`
`protected List<Collection>`	`collections` The collections that this folder belongs to.
`protected Boolean`	`hasCollaborations` Specifies if this folder has any other collaborators.
`protected Boolean`	`isAccessibleViaSharedLink` Specifies if the folder can be accessed with the direct shared link or a shared link to a parent folder.
`protected Boolean`	`isAssociatedWithAppItem` This field will return true if the folder or any ancestor of the folder is associated with at least one app item.
`protected Boolean`	`isCollaborationRestrictedToEnterprise`
`protected Boolean`	`isExternallyOwned` Specifies if this folder is owned by a user outside of the authenticated enterprise.
`protected FolderFullMetadataField`	`metadata`
`protected FolderFullPermissionsField`	`permissions`
`protected EnumWrapper<FolderFullSyncStateField>`	`syncState`
`protected List<String>`	`tags`
`protected FolderFullWatermarkInfoField`	`watermarkInfo`

Fields inherited from class Folder
contentCreatedAt, contentModifiedAt, createdAt, createdBy, description, folderUploadEmail, itemCollection, itemStatus, modifiedAt, modifiedBy, ownedBy, parent, pathCollection, purgedAt, sharedLink, size, trashedAt

Fields inherited from class FolderMini
name, sequenceId

Fields inherited from class FolderBase
etag, id, type

Fields inherited from class NullableFieldTracker
explicitlySetNullableFields

Constructor Summary

Constructors
Modifier Constructor and Description

protected FolderFull(FolderFull.Builder builder)

FolderFull(String id)

Constructors
Modifier	Constructor and Description
`protected`	`FolderFull(FolderFull.Builder builder)`
	`FolderFull(String id)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`List<EnumWrapper<FolderFullAllowedInviteeRolesField>>`	`getAllowedInviteeRoles()`
`List<EnumWrapper<FolderFullAllowedSharedLinkAccessLevelsField>>`	`getAllowedSharedLinkAccessLevels()`
`Boolean`	`getCanNonOwnersInvite()`
`Boolean`	`getCanNonOwnersViewCollaborators()`
`FolderFullClassificationField`	`getClassification()`
`List<Collection>`	`getCollections()`
`Boolean`	`getHasCollaborations()`
`Boolean`	`getIsAccessibleViaSharedLink()`
`Boolean`	`getIsAssociatedWithAppItem()`
`Boolean`	`getIsCollaborationRestrictedToEnterprise()`
`Boolean`	`getIsExternallyOwned()`
`FolderFullMetadataField`	`getMetadata()`
`FolderFullPermissionsField`	`getPermissions()`
`EnumWrapper<FolderFullSyncStateField>`	`getSyncState()`
`List<String>`	`getTags()`
`FolderFullWatermarkInfoField`	`getWatermarkInfo()`
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class Folder
getContentCreatedAt, getContentModifiedAt, getCreatedAt, getCreatedBy, getDescription, getFolderUploadEmail, getItemCollection, getItemStatus, getModifiedAt, getModifiedBy, getOwnedBy, getParent, getPathCollection, getPurgedAt, getSharedLink, getSize, getTrashedAt

Methods inherited from class FolderMini
getName, getSequenceId

Methods inherited from class FolderBase
getEtag, getId, getType

Methods inherited from class SerializableObject
getRawData, setRawData

Methods inherited from class NullableFieldTracker
getExplicitlySetNullableFields, isFieldExplicitlySet, markNullableFieldAsSet, markNullableFieldsAsSet

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - syncState
```
protected EnumWrapper<FolderFullSyncStateField> syncState
```
  - hasCollaborations
```
protected Boolean hasCollaborations
```
    Specifies if this folder has any other collaborators.
  - permissions
```
protected FolderFullPermissionsField permissions
```
  - tags
```
protected List<String> tags
```
  - canNonOwnersInvite
```
protected Boolean canNonOwnersInvite
```
  - isExternallyOwned
```
protected Boolean isExternallyOwned
```
    Specifies if this folder is owned by a user outside of the authenticated enterprise.
  - metadata
```
protected FolderFullMetadataField metadata
```
  - isCollaborationRestrictedToEnterprise
```
protected Boolean isCollaborationRestrictedToEnterprise
```
  - allowedSharedLinkAccessLevels
```
protected List<EnumWrapper<FolderFullAllowedSharedLinkAccessLevelsField>> allowedSharedLinkAccessLevels
```
    The shared link access levels the authenticated user is allowed to use when creating or updating a shared link for this folder.
    The list depends on item policy and user authorization. For some folders, like the root folder, this is always empty as sharing is not allowed at that level.
  - allowedInviteeRoles
```
protected List<EnumWrapper<FolderFullAllowedInviteeRolesField>> allowedInviteeRoles
```
    A list of the types of roles that user can be invited at when sharing this folder.
  - watermarkInfo
```
protected FolderFullWatermarkInfoField watermarkInfo
```
  - isAccessibleViaSharedLink
```
protected Boolean isAccessibleViaSharedLink
```
    Specifies if the folder can be accessed with the direct shared link or a shared link to a parent folder.
  - canNonOwnersViewCollaborators
```
protected Boolean canNonOwnersViewCollaborators
```
    Specifies if collaborators who are not owners of this folder are restricted from viewing other collaborations on this folder.
    It also restricts non-owners from inviting new collaborators.
  - classification
```
protected FolderFullClassificationField classification
```
  - isAssociatedWithAppItem
```
protected Boolean isAssociatedWithAppItem
```
    This field will return true if the folder or any ancestor of the folder is associated with at least one app item. Note that this will return true even if the context user does not have access to the app item(s) associated with the folder.
  - collections
```
protected List<Collection> collections
```
    The collections that this folder belongs to.
    For more information, see the [collections guide](https://developer.box.com/guides/collections).
- Constructor Detail
  - FolderFull
```
public FolderFull(String id)
```
  - FolderFull
```
protected FolderFull(FolderFull.Builder builder)
```
- Method Detail
  - getSyncState
```
public EnumWrapper<FolderFullSyncStateField> getSyncState()
```
  - getHasCollaborations
```
public Boolean getHasCollaborations()
```
  - getPermissions
```
public FolderFullPermissionsField getPermissions()
```
  - getTags
```
public List<String> getTags()
```
  - getCanNonOwnersInvite
```
public Boolean getCanNonOwnersInvite()
```
  - getIsExternallyOwned
```
public Boolean getIsExternallyOwned()
```
  - getMetadata
```
public FolderFullMetadataField getMetadata()
```
  - getIsCollaborationRestrictedToEnterprise
```
public Boolean getIsCollaborationRestrictedToEnterprise()
```
  - getAllowedSharedLinkAccessLevels
```
public List<EnumWrapper<FolderFullAllowedSharedLinkAccessLevelsField>> getAllowedSharedLinkAccessLevels()
```
  - getAllowedInviteeRoles
```
public List<EnumWrapper<FolderFullAllowedInviteeRolesField>> getAllowedInviteeRoles()
```
  - getWatermarkInfo
```
public FolderFullWatermarkInfoField getWatermarkInfo()
```
  - getIsAccessibleViaSharedLink
```
public Boolean getIsAccessibleViaSharedLink()
```
  - getCanNonOwnersViewCollaborators
```
public Boolean getCanNonOwnersViewCollaborators()
```
  - getClassification
```
public FolderFullClassificationField getClassification()
```
  - getIsAssociatedWithAppItem
```
public Boolean getIsAssociatedWithAppItem()
```
  - getCollections
```
public List<Collection> getCollections()
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Folder
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Folder
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Folder

Class FolderFull

Nested Class Summary

Field Summary

Fields inherited from class Folder

Fields inherited from class FolderMini

Fields inherited from class FolderBase

Fields inherited from class NullableFieldTracker

Constructor Summary

Method Summary

Methods inherited from class Folder

Methods inherited from class FolderMini

Methods inherited from class FolderBase

Methods inherited from class SerializableObject

Methods inherited from class NullableFieldTracker

Methods inherited from class Object

Field Detail

syncState

hasCollaborations

permissions

tags

canNonOwnersInvite

isExternallyOwned

metadata

isCollaborationRestrictedToEnterprise

allowedSharedLinkAccessLevels

allowedInviteeRoles

watermarkInfo

isAccessibleViaSharedLink

canNonOwnersViewCollaborators

classification

isAssociatedWithAppItem

collections

Constructor Detail

FolderFull

FolderFull

Method Detail

getSyncState

getHasCollaborations

getPermissions

getTags

getCanNonOwnersInvite

getIsExternallyOwned

getMetadata

getIsCollaborationRestrictedToEnterprise

getAllowedSharedLinkAccessLevels

getAllowedInviteeRoles

getWatermarkInfo

getIsAccessibleViaSharedLink

getCanNonOwnersViewCollaborators

getClassification

getIsAssociatedWithAppItem

getCollections

equals

hashCode

toString