Oracle® Collaboration Suite Workspaces API Reference
10g Release 1 (10.1.2)

B25479-01


oracle.workspaces.resource.files
Class CwFolder

java.lang.Object
  extended byoracle.workspaces.resource.CwResourceItem
      extended byoracle.workspaces.resource.files.CwFilesResourceItem
          extended byoracle.workspaces.resource.files.CwFolder

All Implemented Interfaces:
oracle.ifs.adk.uix.ws.common.BaseAttributes, oracle.ifs.adk.uix.ws.common.BaseItemTypes, CwAttachmentEnabled, CwEntity, CwExceptionConstants, CwFilesConstants, oracle.ifs.files.ws.common.FilesAttributes, oracle.ifs.files.ws.common.FilesItemTypes

public class CwFolder
extends CwFilesResourceItem

Field Summary

Fields inherited from interface oracle.workspaces.resource.files.CwFilesConstants
ACT_DEFAULT, ACT_OVERWRITE, ACT_UNIQUENAME, ACT_VERSION, DEFAULT_ATTRIBUTES, FILE_XFER_BUFFER_SIZE, FILES_ERROR_ITEM_NOT_FOUND, FILES_MAX_DESC_LENGTH, FILES_MAX_NAME_LENGTH, FILES_PATH_SEPARATOR, FILES_WS_ACCESS_DENIED, FILES_WS_ATTRIBUTE_CANNOT_BE_UPDATED, FILES_WS_ATTRIBUTE_UPDATE_ERROR, FILES_WS_ERROR_ESTABLISHING_SESSION, FILES_WS_FAILED_TO_COMMIT_TRANSACTION, FILES_WS_FAILED_TO_ROLLBACK_TRANSACTION, FILES_WS_FOLDER_NOT_EMPTY, FILES_WS_INTERNAL_SERVER_ERROR, FILES_WS_INVALID_ATTRIBUTE, FILES_WS_INVALID_ATTRIBUTE_VALUE, FILES_WS_INVALID_ITEM_NAME, FILES_WS_INVALID_REQUEST, FILES_WS_INVALID_TRANSACTION_ID, FILES_WS_ITEM_ALREADY_EXISTS, FILES_WS_ITEM_LOCKED, FILES_WS_ITEM_NOT_DOCUMENT, FILES_WS_ITEM_NOT_FOLDER, FILES_WS_ITEM_NOT_FOUND, FILES_WS_MAX_NUMBER_OF_PER_USER_CONCURRENT_OPS_EXCEEDED, FILES_WS_OBJECT_TYPE_NOT_MAPPED_ON_SERVER_SIDE, FILES_WS_OPERATION_NOT_ALLOWED, FILES_WS_QUOTA_EXCEEDED, FILES_WS_SERVER_UNAVAILABLE, FILES_WS_SESSION_ALREADY_CONNECTED, FILES_WS_SESSION_NOT_CONNECTED, FILES_WS_TRANSACTION_OUT_OF_ORDER_COMMIT_OR_ROLLBACK_ATTEMPTED, FILES_WS_UNZIP_FAILED, HTTP_FAILURE_CODE_LOWER_BOUND, HTTP_FILE_NOT_FOUND, LIST_FOLDER_ATTRIBUTES, RESOURCE_ID_FOR_NON_WORKSPACE_CONTENT, ROLE_ADMIN, ROLE_READ, ROLE_WRITE, TRASH_PATH_PREFIX, URL_SEPARATOR, WORKSPACE_ID_FOR_NON_WORKSPACE_CONTENT

Fields inherited from interface oracle.ifs.files.ws.common.FilesAttributes
ATTRIBUTE_DEFAULT, ATTRIBUTE_ENUMERATION, ATTRIBUTE_NAME, ATTRIBUTE_REQUIRED, ATTRIBUTE_TYPE, AVAILABLE_CATEGORIES, CATEGORIES, CATEGORY_ALL_ATTRIBUTES, CATEGORY_ATTRIBUTE, CATEGORY_ATTRIBUTES, CATEGORY_NAME, CATEGORY_TYPE, ICON_URL, IS_WORKING_COPY, MEMBER_ROLE, MEMBER_ROLE_ADMIN, MEMBER_ROLE_NONE, MEMBER_ROLE_READ, MEMBER_ROLE_READWRITE, MEMBERS, UPLOAD_URL, VERSION_COMMENT, VERSION_LABEL, WKSP_INITIAL_ADMIN, WKSP_LONG_DESCRIPTION, WKSP_ROOT_FOLDER, WKSP_TYPE, WKSP_TYPE_LISTED, WKSP_TYPE_UNLISTED, WORKING_COPY, WORKSPACE

Fields inherited from interface oracle.ifs.adk.uix.ws.common.BaseAttributes
ACTION_AUTO_NAME, ACTION_DEFAULT, ACTION_OVERWRITE, ACTION_VERSION, CREATE_DATE, CREATED_BY, DESCRIPTION, FAMILY, IS_VERSIONED, ITEM_COUNT, LANGUAGE, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCK_OWNER, LOGGED_IN_USER, MIME_TYPE, OPTION_COUNT, OPTION_FROM, OWNER, PARENT_FOLDER, PATH, PATH_ITEMS, QUOTA_ALLOCATED, QUOTA_USED, SESSION_TIMEOUT_ATTRIBUTE, SIZE, TRANSACTION_TIMEOUT_ATTRIBUTE, URL, VERSIONS

Fields inherited from interface oracle.ifs.files.ws.common.FilesItemTypes
CATEGORY_ATTRIBUTE_TYPE, CATEGORY_DEFINITION_TYPE, WORKSPACE_TYPE

Fields inherited from interface oracle.ifs.adk.uix.ws.common.BaseItemTypes
CATEGORY_TYPE, DOCUMENT_TYPE, FAMILY_TYPE, FOLDER_TYPE, GROUP_TYPE, LINK_TYPE, USER_TYPE

Fields inherited from interface oracle.workspaces.exmsgs.CwExceptionConstants
CW_ADD_NONPARENTMEMBER_TO_SUBWSPC, CW_ANNOUNCEMENT_NOT_FOUND, CW_ASSERTION_ERROR, CW_ASSOCIATION_NOT_FOUND, CW_ATTACHMENT_ARRAY_PARAMS_MISMATCH, CW_ATTACHMENTS_CONTAINER_ERROR, CW_ATTR_SYNTAX_VIOLATION_BODY, CW_ATTR_SYNTAX_VIOLATION_DESCRIPTION, CW_ATTR_SYNTAX_VIOLATION_DISPLAY_NAME, CW_ATTR_SYNTAX_VIOLATION_HOSTNAME, CW_ATTR_SYNTAX_VIOLATION_LOCATION, CW_ATTR_SYNTAX_VIOLATION_NAME, CW_ATTR_SYNTAX_VIOLATION_NON_ASCII_NAME, CW_ATTR_SYNTAX_VIOLATION_NON_ASCII_WORKSPACE_NAME, CW_ATTR_SYNTAX_VIOLATION_PATH, CW_ATTR_SYNTAX_VIOLATION_PORT, CW_ATTR_SYNTAX_VIOLATION_TITLE, CW_ATTR_SYNTAX_VIOLATION_WHITESPACE, CW_ATTR_VAL_INVALID_DISPLAYNAME_DUPLICATION, CW_ATTR_VAL_INVALID_NAME_DUPLICATION, CW_ATTR_VAL_INVALID_NAME_MISSING, CW_ATTR_VAL_INVALID_RSRC_TYPE_DUPLICATION, CW_ATTR_VAL_INVALID_RSRC_TYPE_MISSING, CW_ATTR_VAL_INVALID_TOKEN_NAME_BODY_EXST, CW_ATTR_VAL_INVALID_TOKEN_NAME_BODY_NEW, CW_ATTR_VAL_INVALID_TOKEN_NAME_BODY_REM, CW_ATTR_VAL_INVALID_TOKEN_NAME_BODY_RMV, CW_ATTR_VAL_INVALID_TOKEN_NAME_SUB_EXST, CW_ATTR_VAL_INVALID_TOKEN_NAME_SUB_NEW, CW_ATTR_VAL_INVALID_TOKEN_NAME_SUB_REM, CW_ATTR_VAL_INVALID_TOKEN_NAME_SUB_RMV, CW_CALENDAR_ATLEAST_ONE_ATTENDEE, CW_CALENDAR_ATTENDEE_NOT_FOUND, CW_CALENDAR_CANNOT_BOOK_ATTENDEE_EXCEPTION, CW_CALENDAR_CONFIGURATION_EXCEPTION, CW_CALENDAR_CORRUPTED_EXCEPTION, CW_CALENDAR_CREATE_WEBCONF_PAST_EXCEPTION, CW_CALENDAR_EVENT_ALREADY_EXIST, CW_CALENDAR_EVENT_NOT_FOUND, CW_CALENDAR_HANDLE_BAD_EXCEPTION, CW_CALENDAR_INTERNAL_EXCEPTION, CW_CALENDAR_ITEM_NOT_FOUND, CW_CALENDAR_PROVISION_EXCEPTION, CW_CALENDAR_QUOTA_LIMIT_EXCEPTION, CW_CALENDAR_SESSION_INVALID, CW_CALENDAR_SESSION_INVALID_WITH_WARNING, CW_CALENDAR_TASK_ALREADY_EXIST, CW_CALENDAR_TASK_NOT_FOUND, CW_CALENDAR_UNAVAILABLE_EXCEPTION, CW_CALENDAR_UNSUPPORTED_FOR_REGULAR, CW_CALENDAR_UNSUPPORTED_FOR_REPEATING, CW_CALENDAR_UNSUPPORTED_FOR_TYPE, CW_CANNOT_EDIT_READ_ONLY, CW_CANNOT_REASSIGN_WORKSPACE_OWNER_ROLE, CW_CONFIGURATION_PROPERTY_NOT_FOUND, CW_COULD_NOT_CREATE_CONTENT_SERVICES_CW_ADMIN, CW_DB_CONNECTION_ERROR, CW_DB_EXEC_INTERNAL_ERROR, CW_DEFAULT_PROPERTIES_FILE_CANNOT_BE_LOADED, CW_DEFAULT_WORKSPACE_TEMPLATE_CANNOT_BE_DELETED, CW_DELETE_WORKSPACE_OWNER, CW_DELETE_WORKSPACE_WITH_CHILDREN, CW_DELETE_WORKSPACE_WITH_RESOURCE, CW_DISC_AND_EMAIL_UNAVAILABLE_EXCEPTION, CW_DISCUSSION_CORRUPTED_EXCEPTION, CW_DISCUSSION_EXCEPTION_NO_ERRCODE, CW_DISCUSSION_INTERNAL_EXCEPTION, CW_DISCUSSION_ITEM_ALREADY_EXIST, CW_DISCUSSION_ITEM_NOT_FOUND, CW_DISCUSSION_ITEM_NOT_FOUND_NOARG, CW_DISCUSSION_UNSUPPORTED_PROPERTY, CW_DISCUSSIONS_EMAIL_GUEST_CANNOT_CREATE_RESOURCE, CW_DUPLICATE_ATTACHMENT, CW_DUPLICATE_WS_TEMPLATE_NAME, CW_DUPLICATED_MEMBER_SUPPLIED, CW_EMAIL_CORRUPTED_EXCEPTION, CW_EMAIL_EXCEPTION_NO_ERRCODE, CW_EMAIL_INTERNAL_EXCEPTION, CW_EMAIL_SESSION_INVALID_WITH_WARNING, CW_EXTERNAL_MEMBER_SUPPLIED, CW_FILES_ACCESS_DENIED, CW_FILES_CANNOT_DELETE_ONLY_VERSION, CW_FILES_CANNOT_LOCK_FOLDERS, CW_FILES_CANNOT_OVERRIDE_FINAL_PARENT, CW_FILES_CORRUPTED_EXCEPTION, CW_FILES_FEATURE_DISABLED, CW_FILES_FILE_IS_NOT_CHECKED_OUT, CW_FILES_HTTP_EXCEPTION, CW_FILES_HTTP_LOCKED_EXCEPTION, CW_FILES_INTERNAL_EXCEPTION, CW_FILES_ITEM_ALREADY_EXIST, CW_FILES_ITEM_ALREADY_LOCKED, CW_FILES_ITEM_NOT_FOUND, CW_FILES_MAX_CONCURRENT_OPS_EXCEEDED, CW_FILES_MEMBER_NOT_FOUND, CW_FILES_OPERATION_NOT_ALLOWED_IN_TRASH, CW_FILES_OVER_QUOTA, CW_FILES_SERVER_CONNECTION_LOST, CW_FILES_SESSION_INVALID_WITH_WARNING, CW_FILES_SHARED_FOLDER_NOT_FOUND, CW_FILES_UNAVAILABLE_EXCEPTION, CW_FILES_UNSUPPORTED_NEW_TRASH_ITEM, CW_FILES_UNSUPPORTED_TRASH_LOCK, CW_FILES_VERSIONING_DISABLED, CW_GET_OCS_USER_ERROR, CW_HTTP_INTERNAL_ERROR, CW_HTTP_UNAUTHORIZED_ERROR, CW_HTTP_UNSUPPORTED_AUTH_SCHEME_ERROR, CW_HTTP_UNSUPPORTED_METHOD_ERROR, CW_IMMUTABLE_UNSUPPORTED_OPERATION, CW_INTERNAL_OP_ERROR, CW_INVALID_CONTENT_SERVICES_ADMINISTRATOR, CW_INVALID_CONTENT_SERVICES_CONTAINER_NAME, CW_INVALID_RECIPIENT_EMAIL_ADDRESS, CW_INVALID_SEARCH_CONTAINER, CW_INVALID_SEARCH_ROOT_ENTITY, CW_INVALID_TEMPLATE_SYNTAX, CW_INVALID_USER_EMAIL, CW_INVALID_WS_METADATA_SEARCH_QUERY, CW_IO_INTERNAL_ERROR, CW_LDAP_ATTRIBUTE_ALREADY_EXIST, CW_LDAP_ATTRIBUTE_ALREADY_EXIST_NOARG, CW_LDAP_ATTRIBUTE_NOT_FOUND, CW_LDAP_ATTRIBUTE_NOT_FOUND_NOARG, CW_LDAP_COMMUNICATION_ERROR, CW_LDAP_CONNECTION_ERROR, CW_LDAP_ENTRY_ALREADY_EXIST, CW_LDAP_ENTRY_ALREADY_EXIST_NOARG, CW_LDAP_ENTRY_NOT_FOUND, CW_LDAP_ENTRY_NOT_FOUND_NOARG, CW_LDAP_EXEC_INTERNAL_ERROR, CW_LDAP_GROUP_ALREADY_EXIST, CW_LDAP_GROUP_NOT_FOUND, CW_LDAP_GROUP_NOT_FOUND_NOARG, CW_LDAP_MEMBER_ALREADY_EXIST, CW_LDAP_MEMBER_NOT_FOUND, CW_LDAP_MEMBER_NOT_FOUND_WSNAME_ONLY, CW_LDAP_MISSING_SEARCHBASE_ERROR, CW_LDAP_MISSING_SUBSCRIBER_ERROR, CW_LDAP_USER_NOT_FOUND, CW_LDAP_USER_NOT_FOUND_NOARG, CW_LDAP_WORKSPACE_ALREADY_EXIST, CW_LDAP_WORKSPACE_NOT_FOUND, CW_LDAP_WORKSPACE_NOT_FOUND_NOARG, CW_MEMBER_ALREADY_EXIST, CW_MEMBER_ALREADY_EXIST_NOARG, CW_MEMBER_MGMT_ATTRIBUTE_ERROR, CW_MEMBER_MGMT_MAX_NUMBER_EXCEEDED, CW_MEMBER_NOT_FOUND, CW_MULTIPLE_VIRTUAL_SERVICE_AVAILABLE, CW_NOT_AUTHORIZED, CW_NOT_AUTHORIZED_WORKSPACE_SETTING, CW_NULL_WORKSPACE_PATH, CW_OPERATION_INSTANCE_NOT_FOUND, CW_OPERATION_INSTANCE_NOT_FOUND_NOARG, CW_PARENT_ENTITY_FOUND, CW_PERMISSION_NAME_INVALID, CW_PRIV_MGMT_SELF, CW_PROPERTIES_NULL, CW_PROPERTY_NOT_FOUND, CW_RESERVED_TEMPLATE_CATEGORY, CW_RESOURCE_ALREADY_EXIST, CW_RESOURCE_ATTR_RSRC_TYPE_MISMATCH, CW_RESOURCE_ATTR_VAL_INVALID, CW_RESOURCE_ATTR_VAL_INVALID_RSRC_TYPE_MOIDIFICATION, CW_RESOURCE_ATTR_VAL_INVALID_UID_MOIDIFICATION, CW_RESOURCE_CONTAINS_ATTACHMENT, CW_RESOURCE_NOT_CONFIGURED, CW_RESOURCE_NOT_FOUND, CW_RESOURCE_NOT_FOUND_NO_WSPC, CW_RESOURCE_NOT_FOUND_NOARG, CW_RESOURCE_NOT_INITIALIZED, CW_RESOURCE_NOT_INSTALLED, CW_RESOURCE_NOT_PROVISION_EXCEPTION_WITH_STATUS, CW_RESOURCE_NOT_PROVISION_EXCEPTION_WITHOUT_STATUS, CW_RESOURCE_STATUS_NOT_SUPPORT_IN_RECOVERY, CW_RESOURCE_STATUS_UNACCESSIBLE, CW_ROLE_NOT_FOUND, CW_RSRC_ITEM_INVALID_DESC, CW_RSRC_ITEM_INVALID_NAME, CW_RSRC_ITEM_INVALID_PERCENT, CW_RSRC_ITEM_INVALID_SECURE_CONTENT_GRANTEE, CW_RSRC_ITEM_INVALID_SECURE_CONTENT_PERMISSION, CW_RSRC_ITEM_PARSING_ERROR, CW_RTC_SESSION_INVALID_WITH_WARNING, CW_SEARCH_INTERNAL_EXCEPTION, CW_SEARCH_INVALID_QUERY, CW_SEARCHLET_CONNECTION_EXCEPTION, CW_SEARCHLET_EXEC_EXCEPTION, CW_SEARCHLET_INIT_EXCEPTION, CW_SEARCHLET_JNDI_EXCEPTION, CW_SEARCHLET_USER_CONTEXT_EXCEPTION, CW_SERVICE_CONFIGURATION_ERROR, CW_SERVICE_UNINIT_ERROR, CW_SERVICE_UNINT_WSPC_MGRS, CW_SESSION_INVALID, CW_SESSION_NULL, CW_SUBGROUP_ALREADY_EXIST, CW_SUBGROUP_NOT_FOUND, CW_SUBGROUP_NOT_FOUND_NOARG, CW_SYSTEM_BUSY_EXCEPTION, CW_TEMPLATE_CONTENT_LOCATION_NOT_FOUND, CW_UID_NOT_IN_WORKSPACE, CW_UNSUPPORTED_SEARCH_ROOT_DESCRIPTOR, CW_UNSUPPORTED_SEARCH_TYPE, CW_VIEW_NOT_FOUND, CW_VIRTUAL_SERVICE_ATTRIBUTE_NOT_FOUND, CW_VIRTUAL_SERVICE_NOT_FOUND, CW_VIRTUAL_SERVICE_TYPE_NOT_FOUND, CW_WEBCONF_INTERNAL_EXCEPTION, CW_WORKSPACE_ALREADY_EXIST, CW_WORKSPACE_ATTR_VAL_INVALID, CW_WORKSPACE_BUSY_EXCEPTION, CW_WORKSPACE_CREATION_PARTIAL_SUCCESS, CW_WORKSPACE_DELETION_PARTIAL_SUCCESS, CW_WORKSPACE_DOES_NOT_NEED_RECOVERY, CW_WORKSPACE_NEED_RECOVERY, CW_WORKSPACE_NEED_RECOVERY_ARG, CW_WORKSPACE_NOT_EMPTY, CW_WORKSPACE_NOT_FOUND, CW_WORKSPACE_NOT_FOUND_NOARG, CW_WORKSPACE_NOT_MATCH, CW_WORKSPACE_ROLE_NAME_INVALID, CW_WORKSPACE_ROLE_NOT_MATCH, CW_WORKSPACE_SHARED_FOLDER_MEMBERSHIP_MISMATCH, CW_WORKSPACE_TEMPLATE_NOT_FOUND, CW_XML_INTERNAL_ERROR, ITEM_CREATED_PROPS_UPDATE_FAILED, OPERATION_SUCCESSFUL_WITH_ERRORS, WORKSPACES

Method Summary
CwFile createFile(CwFileDefinition def)
Creates a new file in this folder.
CwFolder createFolder(CwFolderDefinition def)
Creates a new folder under the current one.
void deleteItem(CwUid uid)
Convenience method to delete a single item.
void deleteItems(CwUid[] uids)
Deletes the specified item from this directory after checking that the item is indeed a child of this folder.
CwFilesResourceItem[] listContents()
Lists the contents of the current directory.
CwFilesResourceItem[] listContents(java.lang.String filter)
Lists the contents of the current directory.
void lockItem(CwUid uid)
void lockItems(CwUid[] uids)
void unlockItem(CwUid uid)
void unlockItems(CwUid[] uids)

Methods inherited from class oracle.workspaces.resource.files.CwFilesResourceItem
getLockOwner, getProperties, isLocked, lock, unlock

Methods inherited from class oracle.workspaces.resource.CwResourceItem
addAttachments, getResource, getUid, getWorkspace, isNew, isNew, isUnread, isUnread, listAllAttachments, listAllAttachmentsByType, listAttachments, listAttachmentsByType, listSourceAttachments, listSourceAttachmentsByType, removeAttachments, removeAttachments, storeProperties, supportsCreatedTime, updateAttachments, updateAttachments

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createFile

public CwFile createFile(CwFileDefinition def)
                  throws CwException
Creates a new file in this folder.
Returns:
a reference to the newly created file.
Throws:
CwException

createFolder

public CwFolder createFolder(CwFolderDefinition def)
                      throws CwException
Creates a new folder under the current one.
Returns:
a reference to the newly created subfolder.
Throws:
CwException

deleteItem

public void deleteItem(CwUid uid)
                throws CwException
Convenience method to delete a single item.
Throws:
CwException

deleteItems

public void deleteItems(CwUid[] uids)
                 throws CwException
Deletes the specified item from this directory after checking that the item is indeed a child of this folder.
Throws:
CwException

listContents

public CwFilesResourceItem[] listContents()
                                   throws CwException
Lists the contents of the current directory.
Returns:
an array of files and/or folders.
Throws:
CwException

listContents

public CwFilesResourceItem[] listContents(java.lang.String filter)
                                   throws CwException
Lists the contents of the current directory.
Parameters:
filter - show only items that match this name filter criteria.
Returns:
an array of files and/or folders.
Throws:
CwException

lockItem

public void lockItem(CwUid uid)
              throws CwException
Throws:
CwException

lockItems

public void lockItems(CwUid[] uids)
               throws CwException
Throws:
CwException

unlockItem

public void unlockItem(CwUid uid)
                throws CwException
Throws:
CwException

unlockItems

public void unlockItems(CwUid[] uids)
                 throws CwException
Throws:
CwException

Copyright © 2001, 2005, Oracle. All rights reserved.