FileNet Content Services
Java Connector v3.0

com.filenet.Panagon
Interface Folder

All Superinterfaces:
BaseObject, Folder, GettableObject, LockableObject, PanagonObject, ReadableMetadataObject, ReadableSecurityObject, java.io.Serializable, ValueObject, WorkflowTarget, WriteableMetadataObject, WriteableSecurityObject

public interface Folder
extends PanagonObject, Folder

A Folder object represents a container that can hold other objects. These objects can be subfolders and any object that implements the ContainableObject interface.

This interface defines the custom and system properties associated with a folder. You can retrieve a Properties collection using the getProperties() and getProperties(java.lang.String[] propNames) methods, which are defined in the ReadableMetadataObject superinterface.

The com.filenet.wcm.api.Folder base interface defines methods for instantiating and working with Folder objects.

See Also:
CS Java Connector Developer's Guide

Field Summary
static java.lang.String idmAccessLevel
          Read/Write.
static java.lang.String idmAddedByUser
          Contains the name of the user who added the Folder to the Library.
static java.lang.String idmComment
          Contains a comment about the Folder.
static java.lang.String idmDateAdded
          Contains the date and time the Folder was added to the Library.
static java.lang.String idmFolderReplLibs
          Contains the list of libraries to which this folder is replicated.
static java.lang.String idmFolderReplSource
          Contains the source (server^library) of a target replication folder (the string will be empty for normal folders and source replication folders)
static java.lang.String idmFolderReplType
          Indicates an idmFolderReplTypeXXX type value: idmFolderReplTypeNone, idmFolderReplTypeSource, idmFolderReplTypeSource.
static int idmFolderReplTypeNone
          Property value of 1 for folder type, indicating that folder is not replicated.
static int idmFolderReplTypeSource
          Property value of 2 for folder type, indicating that folder is a source replication folder.
static int idmFolderReplTypeTarget
          Property value of 3 for folder type, indicating that folder is a target replication folder.
static java.lang.String STATE_CAN_CREATE_SUB_FOLDER
          Returns True if the user has sufficient access to create a sub-folder on the folder.
static java.lang.String STATE_CAN_DELETE
          Returns True if the user has sufficient access to delete the folder.
static java.lang.String STATE_CAN_FILE_IN
          Returns True if the user has sufficient access to file objects into the folder.
static java.lang.String STATE_CAN_MODIFY
          Returns True if the user has sufficient access to modify the properties of the folder.
static java.lang.String STATE_CAN_MOVE
          Returns True if the user has sufficient access to move the folder to another folder.
static java.lang.String STATE_CAN_UNFILE
          Returns True if the user has sufficient access to unfile objects filed in the folder.
static java.lang.String STATE_IS_REPLICA
          Returns True if the folder is a Document Services replication folder; returns False for all other DS folders.
 
Fields inherited from interface com.filenet.Panagon.PanagonObject
idmId, idmName
 
Fields inherited from interface com.filenet.wcm.api.BaseObject
EXPORT_DEFAULT, EXPORT_ENCODED_CONTENT, EXPORT_FULL, EXPORT_OBJECT_ID, EXPORT_OBJECT_SECURITY, IMPORT_DEFAULT, IMPORT_OBJECT_ID, IMPORT_OWNER, IMPORT_PERMISSIONS, TYPE_ACTIVE_MARKING, TYPE_ANNOTATION, TYPE_ANY, TYPE_CBR_ENGINE_TYPE, TYPE_CHOICE, TYPE_CHOICELIST, TYPE_CLASS_SUBSCRIPTION, TYPE_CLASSDEFINITION, TYPE_CLASSDESCRIPTION, TYPE_COLUMN_DEFINITION, TYPE_COMPUTER, TYPE_CONTENT_CACHE_SERVICE, TYPE_CONTENT_MGR_SERVICE, TYPE_CONTENT_REFERENCE, TYPE_CONTENT_TRANSFER, TYPE_CUSTOMOBJECT, TYPE_DOCUMENT, TYPE_DOCUMENT_CLASSIFICATION_ACTION, TYPE_DOCUMENT_LIFECYCLE_ACTION, TYPE_DOCUMENT_LIFECYCLE_POLICY, TYPE_DOCUMENTSTATE, TYPE_DOMAIN, TYPE_DYNAMIC_REFERENTIAL_CONTAINMENT_RELATIONSHIP, TYPE_ENTIRENETWORK, TYPE_EVENT, TYPE_EVENT_ACTION, TYPE_FEATURE_ADD_ON, TYPE_FILESTORE, TYPE_FOLDER, TYPE_GROUP, TYPE_INSTANCE_SUBSCRIPTION, TYPE_LINK, TYPE_LOCALIZED_STRING, TYPE_MARKING_SET, TYPE_MULTIPLEVALUES, TYPE_OBJECT_STORE, TYPE_OBJECTSET, TYPE_OBJSTORE_SERVICE, TYPE_PERMISSION, TYPE_PROPERTY_DEFINITION, TYPE_PROPERTYDESCRIPTION, TYPE_PROPERTYDESCRIPTIONS, TYPE_PUBLISH_REQUEST, TYPE_PUBLISH_TEMPLATE, TYPE_READONLY_OBJECT_SET, TYPE_REALM, TYPE_REFERENTIAL_CONTAINMENT_RELATIONSHIP, TYPE_SECURITY_POLICY, TYPE_SECURITY_TEMPLATE, TYPE_STORAGE_POLICY, TYPE_STORED_SEARCH, TYPE_STYLE_TEMPLATE, TYPE_SUBSCRIPTION, TYPE_TABLE_DEFINITION, TYPE_TRANSIENT, TYPE_USER, TYPE_VERSIONSERIES, TYPE_WORKFLOW_CLASS_SUBSCRIPTION, TYPE_WORKFLOW_INSTANCE_SUBSCRIPTION, TYPE_WORKFLOWDEFINITION, TYPE_XML_PROPERTY_MAPPING_SCRIPT
 
Methods inherited from interface com.filenet.wcm.api.BaseObject
equals, exportObject, getClassId, getId, getName, getObjectStoreId, getObjectType, getSession, hashCode, thisBaseObject
 
Methods inherited from interface com.filenet.wcm.api.Folder
addSubFolder, addSubFolder, applySecurityTemplate, changeClass, delete, getAccessMask, getContainees, getContainees, getContainees, getContainees, getContainees, getContainees, getContaineesXML, getContaineesXML, getHeadLinks, getHeadLinksXML, getParentFolder, getParentFolderXML, getPermissionsXML, getSubscriptions, getTailLinks, getTailLinksXML, getUserAccess, getUserAccess, getUserAccess, getUserAccess, getUserAccessXML, move, raiseEvent
 
Methods inherited from interface com.filenet.wcm.api.WorkflowTarget
getWorkflowSubscriptions, getWorkflowSubscriptionsXML, getWorkflowSubscriptionsXML
 
Methods inherited from interface com.filenet.wcm.api.WriteableSecurityObject
setPermissions, setPermissions
 
Methods inherited from interface com.filenet.wcm.api.WriteableMetadataObject
setProperties
 
Methods inherited from interface com.filenet.wcm.api.ReadableMetadataObject
getProperties, getProperties, getPropertiesXML, getPropertyBinaryValue, getPropertyBooleanValue, getPropertyDateValue, getPropertyDoubleValue, getPropertyIntValue, getPropertyStringValue, getPropertyValue, getPropertyValuesValue, refresh, refresh
 
Methods inherited from interface com.filenet.wcm.api.ReadableSecurityObject
getPermissions, getPermissions
 
Methods inherited from interface com.filenet.wcm.api.LockableObject
extendLock, extendLock, isLocked, lock, unlock, unlock
 

Field Detail

idmFolderReplTypeNone

public static final int idmFolderReplTypeNone
Property value of 1 for folder type, indicating that folder is not replicated.

See Also:
Constant Field Values

idmFolderReplTypeSource

public static final int idmFolderReplTypeSource
Property value of 2 for folder type, indicating that folder is a source replication folder.

See Also:
Constant Field Values

idmFolderReplTypeTarget

public static final int idmFolderReplTypeTarget
Property value of 3 for folder type, indicating that folder is a target replication folder.

See Also:
Constant Field Values

idmComment

public static final java.lang.String idmComment
Contains a comment about the Folder.

See Also:
Constant Field Values

idmAddedByUser

public static final java.lang.String idmAddedByUser
Contains the name of the user who added the Folder to the Library.

See Also:
Constant Field Values

idmDateAdded

public static final java.lang.String idmDateAdded
Contains the date and time the Folder was added to the Library.

See Also:
Constant Field Values

idmFolderReplType

public static final java.lang.String idmFolderReplType
Indicates an idmFolderReplTypeXXX type value: idmFolderReplTypeNone, idmFolderReplTypeSource, idmFolderReplTypeSource.

See Also:
Constant Field Values

idmFolderReplLibs

public static final java.lang.String idmFolderReplLibs
Contains the list of libraries to which this folder is replicated.

See Also:
Constant Field Values

idmFolderReplSource

public static final java.lang.String idmFolderReplSource
Contains the source (server^library) of a target replication folder (the string will be empty for normal folders and source replication folders)

See Also:
Constant Field Values

idmAccessLevel

public static final java.lang.String idmAccessLevel
Read/Write. Contains the current user's access to the Folder object (Admin, Owner, Author, Viewer, None). See the Permission interface for a list of idmAccessLevel values .

See Also:
Constant Field Values

STATE_CAN_CREATE_SUB_FOLDER

public static final java.lang.String STATE_CAN_CREATE_SUB_FOLDER
Returns True if the user has sufficient access to create a sub-folder on the folder.

See Also:
Constant Field Values

STATE_CAN_DELETE

public static final java.lang.String STATE_CAN_DELETE
Returns True if the user has sufficient access to delete the folder.

See Also:
Constant Field Values

STATE_CAN_FILE_IN

public static final java.lang.String STATE_CAN_FILE_IN
Returns True if the user has sufficient access to file objects into the folder.

See Also:
Constant Field Values

STATE_CAN_MODIFY

public static final java.lang.String STATE_CAN_MODIFY
Returns True if the user has sufficient access to modify the properties of the folder.

See Also:
Constant Field Values

STATE_CAN_MOVE

public static final java.lang.String STATE_CAN_MOVE
Returns True if the user has sufficient access to move the folder to another folder.

See Also:
Constant Field Values

STATE_CAN_UNFILE

public static final java.lang.String STATE_CAN_UNFILE
Returns True if the user has sufficient access to unfile objects filed in the folder.

See Also:
Constant Field Values

STATE_IS_REPLICA

public static final java.lang.String STATE_IS_REPLICA
Returns True if the folder is a Document Services replication folder; returns False for all other DS folders.

See Also:
Constant Field Values

FileNet Content Services
Java Connector v3.0