| Package | Description |
|---|---|
| com.uc4.api.objects |
This package contains classes related to objects in the Automation Engine.
|
| com.uc4.communication.requests |
This package contains request classes that can be sent using the
Connection class. |
| com.uc4.util |
| Modifier and Type | Method and Description |
|---|---|
IFolder |
IFolder.getParent()
Returns the parent folder of this folder.
|
IFolder |
IFolder.getSubFolder(java.lang.String name,
boolean recursive)
Returns a subfolder with the specified name.
|
| Modifier and Type | Method and Description |
|---|---|
java.util.Iterator<IFolder> |
IFolder.subfolder()
Returns an iterator for subfolders
Each object in the list implements the
IFolder interface. |
| Modifier and Type | Method and Description |
|---|---|
IFolder |
FolderTree.getFavoritesFolder()
Returns an
IFolder object which represents the "Favorites Folder". |
IFolder |
CheckAuthorizations.Candidate.getFolder()
Returns the name of the Folder.
|
IFolder |
CreateObject.getFolder()
Returns the
IFolder where the object should be created. |
IFolder |
FolderTree.getFolder(java.lang.String path)
Returns the folder for the given path or
null
if the folder was not found. |
IFolder |
FolderTree.getFolderByID(java.lang.String id)
Returns an folder object with the specified ID or
null if not found. |
IFolder |
FolderTree.getNoFolder()
Returns an
IFolder object which represents the "No Folder". |
IFolder |
FolderTree.getRecentObjects()
Returns an
IFolder object which represents the "Recent Objects" folder. |
IFolder |
FolderTree.getRecycleBin()
Returns an
IFolder object which represents the "Recycle Bin" folder. |
IFolder |
FolderTree.getTransportFolder()
Returns an
IFolder object which represents the transport case folder. |
IFolder |
FolderTree.getVersionManagement()
Returns an
IFolder object which represents the "Version Management" folder. |
IFolder |
FolderTree.root()
Returns the root folder of the client.
|
| Modifier and Type | Method and Description |
|---|---|
ImportObject |
ExportObject.getImportRequest(IFolder folder,
boolean overwriteObject,
boolean keepFolderLinks)
Creates an ImportObject request from the export.
|
| Constructor and Description |
|---|
Candidate(IFolder folder,
UserRight.Type objectType,
char access)
Creates a new
Candidate instance. |
CreateObject(UC4ObjectName name,
Template template,
IFolder folder)
Creates an UC4 Object.
|
DeleteObject(IFolder folder)
This constructor is used to delete FOLD objects in UC4.
|
DeleteObject(IFolder[] folders)
This constructor is used to delete multiple FOLD objects in AE.
|
DeleteObject(UC4ObjectName[] names,
IFolder[] folders)
This constructor is used to delete multiple FOLD and UC4Object objects in AE.
|
DeleteObject(UC4ObjectName objectName,
IFolder folder)
Constructs a
DeleteObject using the specified UC4 object name. |
DuplicateObject(UC4ObjectName name,
UC4ObjectName newName,
IFolder folder)
Creates a new
DuplicateObject request. |
DuplicateObject(UC4ObjectName name,
UC4ObjectName newName,
IFolder folder,
java.lang.String title)
Creates a new
DuplicateObject request. |
DuplicateObject(UC4Object object,
UC4ObjectName newName,
IFolder folder)
Creates a new
DuplicateObject request. |
ExportObject(IFolder[] folders,
java.io.File export,
boolean exportLinks)
Exports a list of UC4 Folders.
|
ExportObject(IFolder folder,
java.io.File export,
boolean exportLinks)
Exports a single folder structure.
|
FolderList(IFolder folder)
Constructs a new
FolderList to list the
content of the specified folder. |
FolderList(IFolder folder,
boolean executableOnly)
Constructs a new
FolderList to list the
content of the specified folder. |
FolderList(IFolder folder,
java.util.List<java.lang.String> objectTypes)
Constructs a new
FolderList to list the
content of the specified folder. |
ImportObject(java.nio.ByteBuffer byteBuffer,
IFolder folder,
boolean overwriteObject,
boolean keepFolderLinks)
Creates a request to import UC4 Objects.
|
ImportObject(java.io.File exportFile,
IFolder folder,
boolean overwriteObject,
boolean keepFolderLinks)
Creates a request to import UC4 Objects.
|
LinkTo(FolderListItem object,
IFolder targetFolder)
Creates a new link request.
|
LinkTo(java.util.List<FolderListItem> objectsList,
IFolder targetFolder)
Creates a new link request.
|
MoveObject(FolderListItem item,
IFolder source,
IFolder target)
Moves an object from a source folder to a target folder.
|
MoveObject(java.util.List<FolderListItem> items,
IFolder source,
IFolder target)
Moves list of objects from a source folder to a target folder.
|
MoveUserToClient(UC4UserName user,
IFolder folder,
int client)
Creates a new instance of the
MoveUserToClient request. |
RenameObject(IFolder oldName,
UC4ObjectName newName)
This constructor is used to rename folders.
|
RenameObject(IFolder oldName,
UC4ObjectName newName,
java.lang.String title)
This constructor is used to rename folders.
|
RenameObject(UC4ObjectName oldName,
UC4ObjectName newName,
IFolder folder)
Deprecated.
Use RenameObject(UC4ObjectName oldName, UC4ObjectName newName, IFolder folder, String title) instead
|
RenameObject(UC4ObjectName oldName,
UC4ObjectName newName,
IFolder folder,
java.lang.String title)
Constructs a
RenameObject. |
TemplateList(IFolder folder)
Creates a list of templates in a specified folder.
|
| Constructor and Description |
|---|
ExportObject(UC4ObjectName[] names,
java.util.List<IFolder> folders,
java.io.File export,
boolean exportLinks)
Export given folder list and objects
|
MoveUserToClient(java.util.List<UC4UserName> users,
java.util.List<IFolder> folderList,
int client)
Creates a new instance of the
MoveUserToClient request. |
| Modifier and Type | Class and Description |
|---|---|
class |
FolderImpl
Implementation of the folder interface
|
| Modifier and Type | Method and Description |
|---|---|
IFolder |
FolderImpl.getParent() |
IFolder |
FolderImpl.getSubFolder(java.lang.String folderName,
boolean recursive) |
| Modifier and Type | Method and Description |
|---|---|
java.util.Iterator<IFolder> |
FolderImpl.subfolder() |
| Modifier and Type | Method and Description |
|---|---|
void |
FolderImpl.setParent(IFolder parent)
Sets the parent folder
|