com.sun.slamd.server
Class JobFolder

java.lang.Object
  com.sun.slamd.server.JobFolder

public class JobFolder

extends java.lang.Object

This class defines a job folder data type that is used to hold various properties about a SLAMD job folder.

Constructor Summary

JobFolder(java.lang.String name, java.lang.String description, boolean isVirtual, boolean displayInReadOnlyMode)
Creates a new job folder object with the provided information.

Method Summary

boolean	displayInReadOnlyMode() Indicates whether this job folder should be displayed in restricted read-only mode.
java.lang.String	getDescription() Retrieves the description for this job folder.
java.lang.String	getName() Retrieves the name of this job folder.
boolean	isVirtual() Indicates whether this job folder is a real folder or a virtual folder.

Methods inherited from class java.lang.Object

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

Constructor Detail

JobFolder

public JobFolder(java.lang.String name,
                 java.lang.String description,
                 boolean isVirtual,
                 boolean displayInReadOnlyMode)

Creates a new job folder object with the provided information.

Parameters:

name - The name for this job folder.

description - The description for this job folder, if there is one.

isVirtual - Indicates whether this is a virtual job folder or a real job folder.

displayInReadOnlyMode - Indicates whether this job folder should be displayed in restricted read-only mode.

Method Detail

getName

public java.lang.String getName()

Retrieves the name of this job folder.

Returns:

The name of this job folder.

getDescription

public java.lang.String getDescription()

Retrieves the description for this job folder.

Returns:

The description for this job folder.

isVirtual

public boolean isVirtual()

Indicates whether this job folder is a real folder or a virtual folder.

Returns:

true if this is a virtual job folder, or false if it is a real job folder.

displayInReadOnlyMode

public boolean displayInReadOnlyMode()

Indicates whether this job folder should be displayed in restricted read-only mode.

Returns:

true if this folder should be displayed in restricted read-only mode, or false if not.