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

B25479-01


oracle.workspaces.resource.files
Class CwFileVersionProperties

java.lang.Object
  extended byoracle.workspaces.resource.CwResourceItemProperties
      extended byoracle.workspaces.resource.files.CwFilesItemProperties
          extended byoracle.workspaces.resource.files.CwFilesItemWithContentProperties
              extended byoracle.workspaces.resource.files.CwFileProperties
                  extended byoracle.workspaces.resource.files.CwFileVersionProperties

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

public class CwFileVersionProperties
extends CwFileProperties

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

Method Summary
CwUid getParentFolderUid()
TODO: It always returns null since the versioned item id is different from the roiginal item id.
java.lang.String getVersionComment()
Gets version comments
java.lang.String getVersionLabel()
Gets the version label.
long getVersionNumber()
Gets version comments
boolean isDoNotPurge()
Returns whether the "do-not-purge" flag has been set.
boolean isVersioned()
Always versioned.
boolean isWorkingCopy()
Return whether the current file is the working copy.
void setDoNotPurge(boolean isDoNotPurge)
Sets the "do-not-purge" flag on this version.
void setVersionComment(java.lang.String comment)
Sets the version comments.
void setVersionLabel(java.lang.String label)
Sets the version label.

Methods inherited from class oracle.workspaces.resource.files.CwFileProperties
getCheckedOutBy, getCheckOutComment, getCheckOutDate, isAutoVersioned, isCheckedOut, isVersionEnabled

Methods inherited from class oracle.workspaces.resource.files.CwFilesItemWithContentProperties
getCharset, getLanguage, getMimeType, getSize, setCharset, setLanguage

Methods inherited from class oracle.workspaces.resource.files.CwFilesItemProperties
getCreatedBy, getCreatedTime, getDescription, getLastModifiedBy, getLastModifiedTime, getLockOwner, getName, getParentFolderName, getParentFolderPath, getPath, getUrl, getWorkspaceAllocatedQuota, getWorkspaceConsumedQuota, isInTrashFolder, isLocked, setDescription, setName

Methods inherited from class oracle.workspaces.resource.CwResourceItemProperties
getLastAccessTime, getOwner, getUid

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

Method Detail

getParentFolderUid

public CwUid getParentFolderUid()
                         throws CwException
TODO: It always returns null since the versioned item id is different from the roiginal item id. Also, getName() return "_VD" in the end.
Overrides:
getParentFolderUid in class CwFilesItemProperties
Throws:
CwException

getVersionComment

public java.lang.String getVersionComment()
                                   throws CwException
Gets version comments
Throws:
CwException

getVersionLabel

public java.lang.String getVersionLabel()
                                 throws CwException
Gets the version label.
Throws:
CwException

getVersionNumber

public long getVersionNumber()
                      throws CwException
Gets version comments
Throws:
CwException

isDoNotPurge

public boolean isDoNotPurge()
                     throws CwException
Returns whether the "do-not-purge" flag has been set.
Throws:
CwException

isVersioned

public boolean isVersioned()
Always versioned.
Overrides:
isVersioned in class CwFileProperties

isWorkingCopy

public boolean isWorkingCopy()
                      throws CwException
Return whether the current file is the working copy.
Throws:
CwException

setDoNotPurge

public void setDoNotPurge(boolean isDoNotPurge)
                   throws CwException
Sets the "do-not-purge" flag on this version.
Throws:
CwException

setVersionComment

public void setVersionComment(java.lang.String comment)
                       throws CwException
Sets the version comments. This can be called by a user and updated on an existing file.
Throws:
CwException

setVersionLabel

public void setVersionLabel(java.lang.String label)
                     throws CwException
Sets the version label. This can be called by a user and set on an existing property set.
Throws:
CwException

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