com.uc4.api.objects

Class OutputFiles

java.lang.Object

com.uc4.api.objects.OutputFiles

public class OutputFiles
extends java.lang.Object

This class represents the "Output" tab of Job objects.

Method Summary

Modifier and Type	Method and Description
void	addFile(java.lang.String fullPath, java.lang.Boolean userLogin) Adds a new file.
void	clear() Removes all registered files.
java.lang.String[]	fileList()
java.util.Map<java.lang.String,java.lang.Boolean>	getFileData() Returns an unmodifiable map which contains output files data.
boolean	requiresUserLogin(java.lang.String fullPath) This method checks if the specified file requires a user login.

Methods inherited from class java.lang.Object

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

Method Detail

fileList

public java.lang.String[] fileList()

Returns:

List of registered file names

addFile

public void addFile(java.lang.String fullPath,
                    java.lang.Boolean userLogin)

Adds a new file.

Parameters:

fullPath - name and path of the file

userLogin - true if a user login should be required in order to get this file

requiresUserLogin

public boolean requiresUserLogin(java.lang.String fullPath)

This method checks if the specified file requires a user login.

Parameters:

fullPath - Name and path of the file

Returns:

true if the file requires a user login

clear

public void clear()

Removes all registered files.

getFileData

public java.util.Map<java.lang.String,java.lang.Boolean> getFileData()

Returns an unmodifiable map which contains output files data. Key is filename and value is a flag(is login-required for the file).

Returns:

file map