MOVEitFolderInfo

java.lang.Object
- com.stdnet.moveit.api.MOVEitObjectInfo
- - com.stdnet.moveit.api.MOVEitFilesystemObjectInfo
  - - com.stdnet.moveit.api.MOVEitFolderInfo

```
public class MOVEitFolderInfo
extends MOVEitFilesystemObjectInfo
```
Container object used to provide information about a specific folder on a MOVEit Transfer server. Instances of the object are returned by various methods of the Client object. An instance of the object is populated using information returned from the MOVEit Transfer host, and then passed on to the calling program, which can then access the information through the available methods.

Constructor Summary

Constructors
Constructor and Description

MOVEitFolderInfo()

Constructors
Constructor and Description
`MOVEitFolderInfo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`allowOverwrite()` Indicates whether files of the same name will silently overwrite existing files of the same name.
`int`	`cleanTime()` Describes how often automated clean up is performed on this folder, if used.
`int`	`cleanType()` Describes what kind of automated clean up is regularly performed on this folder.
`java.lang.String`	`description()` Description of this folder.
`int`	`fileCount()` Count of all files in the folder.
`int`	`fileMaskRule()` Indicates whether files uploaded to the folder that match the configured filemasks will be allowed or denied.
`java.lang.String`	`fileMasks()` Comma-delimited list of filemasks which all files uploaded to the folder will be matched against.
`int`	`folderType()` Indicates what kind of folder this is.
`int`	`newFileCount()` Count of new files in the folder.
`int`	`newTime()` The maximum amount of time, in days, that files in this folder are considered "new".
`int`	`noteDelRcpType()` Describes what kind of delivery recipient notifications are used in this folder.
`int`	`noteNewFileTime()` Describes how often new file batch notifications are sent, if used.
`int`	`noteNewFileType()` Describes what kind of new file notifications are used in this folder.
`int`	`noteNoDownloadTime()` Describes how often "no download" batch notifications are sent, if used.
`int`	`noteNoDownloadType()` Describes what kind of "no download" notifications are used in this folder.
`int`	`noteUpConfirmTime()` Describes how often upload confirmation batch notifications are sent, if used.
`int`	`noteUpConfirmType()` Describes what kind of upload confirmation notifications are used in this folder.
`java.lang.String`	`owner()` If this folder is a mailbox, the username of the mailbox owner.
`java.lang.String`	`ownerID()` If this folder is a mailbox, the user ID of the mailbox owner.
`java.lang.String`	`ownerRealname()` If this folder is a mailbox, the realname of the mailbox owner.
`int`	`parentInheritRights()` Indicates whether the folder inherits its permissions from its parent folder.
`java.lang.String`	`pathHash()` The identifying hash associated with this folder's path.
`java.lang.String`	`permission()` A MOVEit Permission String describing the currently authorized user's permissions on this folder.
`long`	`quota()` The folder quota, if any, in bytes.
`java.lang.String`	`responseText()` For webpost folders, text to display after a post to this folder.
`int`	`responseTime()` For webpost folders, the time after which redirection occurs, if used.
`int`	`responseType()` For webpost folders, the webpost completion and redirection setting.
`int`	`subfolderCleanTime()` Describes how often automated clean up of empty subfolders is performed on this folder, if used.
`int`	`subfolderCount()` Count of subfolders in the folder.
`int`	`systemType()` Indicates if this folder is under the control of users or the MOVEit Transfer system.
`int`	`useUniqueNames()` Indicates whether files in this folder must have unique names.

Methods inherited from class com.stdnet.moveit.api.MOVEitFilesystemObjectInfo
ID, instID, name, orgID, parentID, path

Methods inherited from class com.stdnet.moveit.api.MOVEitObjectInfo
dataInitialized

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MOVEitFolderInfo
```
public MOVEitFolderInfo()
```
- Method Detail
  - pathHash
```
public java.lang.String pathHash()
```
    The identifying hash associated with this folder's path. Normally, this will be a blank string, but if the folder is a subfolder of a virtual folder, the hash uniquely identifies the folder path.
    
    Returns:
    
    Folder path hash
  - owner
```
public java.lang.String owner()
```
    If this folder is a mailbox, the username of the mailbox owner.
    
    Returns:
    
    Mailbox owner username
  - ownerID
```
public java.lang.String ownerID()
```
    If this folder is a mailbox, the user ID of the mailbox owner.
    
    Returns:
    
    Mailbox owner user ID
  - ownerRealname
```
public java.lang.String ownerRealname()
```
    If this folder is a mailbox, the realname of the mailbox owner.
    
    Returns:
    
    Mailbox owner realname
  - description
```
public java.lang.String description()
```
    Description of this folder.
    
    Returns:
    
    Folder description
  - systemType
```
public int systemType()
```
    Indicates if this folder is under the control of users or the MOVEit Transfer system. (System folders are automatically created when an organization is added and deleted when an organization is deleted.) A value of 0 indicates a user folder; a value of 1 indicates a system folder.
    
    Returns:
    
    Folder system type code
  - folderType
```
public int folderType()
```
    Indicates what kind of folder this is.
    Possible codes are:
    - 4 = Distribution folder
    - 7 = Home folder
    - 10 = Archive folder
    - 19 = WebPost folder
    Returns:
    
    Folder type code
  - cleanType
```
public int cleanType()
```
    Describes what kind of automated clean up is regularly performed on this folder.
    0 = never
    2 = after CleanTime days
    
    Returns:
    
    Folder automated clean-up code
  - cleanTime
```
public int cleanTime()
```
    Describes how often automated clean up is performed on this folder, if used.
    
    Returns:
    
    Folder automated clean-up time in days
  - subfolderCleanTime
```
public int subfolderCleanTime()
```
    Describes how often automated clean up of empty subfolders is performed on this folder, if used.
    
    Returns:
    
    Folder automated empty subfolder clean-up time in days
  - noteUpConfirmType
```
public int noteUpConfirmType()
```
    Describes what kind of upload confirmation notifications are used in this folder.
    0 = none
    3 = in batch every NoteUpConfirmTime minutes
    16 = immediately
    
    Returns:
    
    Upload confirmation notification setting
  - noteUpConfirmTime
```
public int noteUpConfirmTime()
```
    Describes how often upload confirmation batch notifications are sent, if used.
    
    Returns:
    
    Upload confirmation batch notification time in minutes
  - noteNewFileType
```
public int noteNewFileType()
```
    Describes what kind of new file notifications are used in this folder.
    0 = none
    3 = in batch every NoteNewFileTime minutes
    16 = immediately
    
    Returns:
    
    New file notification setting
  - noteNewFileTime
```
public int noteNewFileTime()
```
    Describes how often new file batch notifications are sent, if used.
    
    Returns:
    
    New file batch notification time in minutes
  - noteNoDownloadType
```
public int noteNoDownloadType()
```
    Describes what kind of "no download" notifications are used in this folder.
    0 = none
    1 = after NoteNoDownloadTime hours
    2 = after NoteNoDownloadTime days
    3 = after NoteNoDownloadTime minutes
    
    Returns:
    
    No download notification setting
  - noteNoDownloadTime
```
public int noteNoDownloadTime()
```
    Describes how often "no download" batch notifications are sent, if used.
    
    Returns:
    
    No download batch notification time
  - noteDelRcpType
```
public int noteDelRcpType()
```
    Describes what kind of delivery recipient notifications are used in this folder.
    0 = none
    16 = immediately
    
    Returns:
    
    delivery receipt notification setting
  - responseType
```
public int responseType()
```
    For webpost folders, the webpost completion and redirection setting.
    0 = redirect immediately
    1 = redirect after ResponseTime seconds
    
    Returns:
    
    Response type setting
  - responseText
```
public java.lang.String responseText()
```
    For webpost folders, text to display after a post to this folder.
    
    Returns:
    
    Response text
  - responseTime
```
public int responseTime()
```
    For webpost folders, the time after which redirection occurs, if used.
    
    Returns:
    
    Webpost redirection time in seconds
  - newTime
```
public int newTime()
```
    The maximum amount of time, in days, that files in this folder are considered "new".
    
    Returns:
    
    Max new time in days
  - useUniqueNames
```
public int useUniqueNames()
```
    Indicates whether files in this folder must have unique names. If this setting is set to 0, then FTP, SSH and API users will see files in this folder listed as "[OnlyName]_[FileID].[OnlyExt]". For example, given two copies of "readme.txt" with fileID's of "111111" and "222222", a directory listing would display "readme_111111.txt" and "readme_222222.txt". If set to 1, two files with the same name cannot be uploaded to this folder.
    
    Returns:
    
    Unique names setting
  - allowOverwrite
```
public int allowOverwrite()
```
    Indicates whether files of the same name will silently overwrite existing files of the same name. An overwrite operation actually deletes the old file and then creates a new ID for the new file. This setting only applies if the useUniqueNames property is set to 1. (0 = No, 1 = Yes)
    
    Returns:
    
    Allow overwrite setting
  - parentInheritRights
```
public int parentInheritRights()
```
    Indicates whether the folder inherits its permissions from its parent folder. This setting only applies if the folder's parentID property is not 0. (0 = No, 1 = Yes)
    
    Returns:
    
    Parent inherit rights setting
  - quota
```
public long quota()
```
    The folder quota, if any, in bytes. (Unlimited quotas are represented with a value of 0.)
    
    Returns:
    
    Folder quota setting
  - permission
```
public java.lang.String permission()
```
    A MOVEit Permission String describing the currently authorized user's permissions on this folder.
    Possible permission codes:
    - A = admin
    - E = subfolders
    - D = delete
    - L = list
    - N = notify
    - R = read
    - W = write
    Returns:
    
    Permission string
  - fileMaskRule
```
public int fileMaskRule()
```
    Indicates whether files uploaded to the folder that match the configured filemasks will be allowed or denied.
    0 = allow all files except those matching a mask
    1 = deny all files except those matching a mask
    
    Returns:
    
    File mask matching rule
  - fileMasks
```
public java.lang.String fileMasks()
```
    Comma-delimited list of filemasks which all files uploaded to the folder will be matched against. Matched files will be allowed or denied based on the fileMaskRule setting. Filemasks may contain the multi-wildcard "*" and single-wildcard "?" characters. (eg, *.txt,frog.*,sni???.ach)
    
    Returns:
    
    Comma-delimited list of file masks
  - subfolderCount
```
public int subfolderCount()
```
    Count of subfolders in the folder.
    
    Returns:
    
    Subfolder count, or -1 if unknown
  - newFileCount
```
public int newFileCount()
```
    Count of new files in the folder. If the folder is a mailbox, this value will reflect the number of new messages in the mailbox.
    
    Returns:
    
    New files (or new messages) count, or -1 if unknown
  - fileCount
```
public int fileCount()
```
    Count of all files in the folder. If the folder is a mailbox, this value will reflect the number of messages in the mailbox.
    
    Returns:
    
    Files (or messages) count, or -1 if unknown

Class MOVEitFolderInfo

Constructor Summary

Method Summary

Methods inherited from class com.stdnet.moveit.api.MOVEitFilesystemObjectInfo

Methods inherited from class com.stdnet.moveit.api.MOVEitObjectInfo

Methods inherited from class java.lang.Object

Constructor Detail

MOVEitFolderInfo

Method Detail

pathHash

owner

ownerID

ownerRealname

description

systemType

folderType

cleanType

cleanTime

subfolderCleanTime

noteUpConfirmType

noteUpConfirmTime

noteNewFileType

noteNewFileTime

noteNoDownloadType

noteNoDownloadTime

noteDelRcpType

responseType

responseText

responseTime

newTime

useUniqueNames

allowOverwrite

parentInheritRights

quota

permission

fileMaskRule

fileMasks

subfolderCount

newFileCount

fileCount