wt.folder
Interface CabinetBased

All Superinterfaces:

FolderServiceManaged, NetFactor, ObjectMappable, Persistable, Serializable

All Known Subinterfaces:

CabinetMember, Folder, Foldered, FolderEntry, IteratedFoldered, Shortcut

All Known Implementing Classes:

Cabinet, CabinetManaged, FolderedBookmark, FolderResident, ImportSession, IteratedFolderResident, IteratedShortcutLink, Managed, Project, RevisionControlled, ShortcutLink, SubFolder, TeamTemplate, WfProcessTemplate

public interface CabinetBased

extends FolderServiceManaged

An interface that defines information as being part of a Cabinet and Folder organization structure. All CabinetBased information has a location that can be described by a path.

Supported API: true

Extendable: false

Field Summary

static String	CABINET_REFERENCE Label for the attribute; A reference to the cabinet that the entry is consided part of.
static String	FOLDER_PATH Label for the attribute; The complete path for the object.
static String	LOCATION Label for the attribute; The location, described as a path for the object.
static String	NAME Label for the attribute; A name for the information.

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Method Summary

CabinetReference	getCabinetReference() Gets the value of the attribute: CABINET_REFERENCE.
String	getFolderPath() Gets the value of the attribute: FOLDER_PATH.
String	getLocation() Gets the value of the attribute: LOCATION.
String	getName() Gets the value of the attribute: NAME.

Methods inherited from interface wt.fc.Persistable

checkAttributes, getIdentity, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.ObjectMappable

readExternal, writeExternal

Methods inherited from interface wt.fc.NetFactor

getClassInfo, getConceptualClassname

Field Detail

NAME

public static final String NAME

Label for the attribute; A name for the information. This name becomes a component of the full path of the object. The name is derived from the object itself.

Supported API: false

See Also:

Constant Field Values

FOLDER_PATH

public static final String FOLDER_PATH

Label for the attribute; The complete path for the object. The path includes the location with the name appended. This information is calculated.

Supported API: false

See Also:

Constant Field Values

LOCATION

public static final String LOCATION

Label for the attribute; The location, described as a path for the object. The location does not include the object's name, but rather indicates what Folder (Cabinet or SubFolder) that the object resides in. This information is calculated.

Supported API: false

See Also:

Constant Field Values

CABINET_REFERENCE

public static final String CABINET_REFERENCE

Label for the attribute; A reference to the cabinet that the entry is consided part of.

Supported API: false

See Also:

Constant Field Values

Method Detail

getName

public String getName()

Gets the value of the attribute: NAME. A name for the information. This name becomes a component of the full path of the object. The name is derived from the object itself.

Supported API: false

Returns:

String

getFolderPath

public String getFolderPath()

Gets the value of the attribute: FOLDER_PATH. The complete path for the object. The path includes the location with the name appended. This information is calculated.

Supported API: false

Returns:

String

getLocation

public String getLocation()

Gets the value of the attribute: LOCATION. The location, described as a path for the object. The location does not include the object's name, but rather indicates what Folder (Cabinet or SubFolder) that the object resides in. This information is calculated.

Supported API: false

Returns:

String

getCabinetReference

public CabinetReference getCabinetReference()

Gets the value of the attribute: CABINET_REFERENCE. A reference to the cabinet that the entry is consided part of.

Supported API: false

Returns:

CabinetReference