oracle.workspaces.resource.files
Class CwFileProperties

java.lang.Object
oracle.workspaces.resource.CwResourceItemProperties
oracle.workspaces.resource.files.CwFilesItemProperties
oracle.workspaces.resource.files.CwFilesItemWithContentProperties
oracle.workspaces.resource.files.CwFileProperties

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

Direct Known Subclasses:

CwFileVersionProperties

public class CwFileProperties

extends CwFilesItemWithContentProperties

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

CwUser	getCheckedOutBy() Returns the user that has the file checked out, or null if the file is not checked out.
java.lang.String	getCheckOutComment() Returns the user that has the file checked out, or null if the file is not checked out.
java.util.Date	getCheckOutDate() Returns the user that has the file checked out, or null if the file is not checked out.
boolean	isAutoVersioned() Return whether the current file is auto-versioned.
boolean	isCheckedOut() Returns true if the item is currently checked out.
boolean	isVersioned() This method should only be called when the isWorkingCopy var is being initialized from the Files backend store.
boolean	isVersionEnabled() Return whether the current file is version-enabled.

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, getParentFolderUid, 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

getCheckedOutBy

public CwUser getCheckedOutBy()
                       throws CwException

Returns the user that has the file checked out, or null if the file is not checked out.

Throws:

CwException

getCheckOutComment

public java.lang.String getCheckOutComment()
                                    throws CwException

Returns the user that has the file checked out, or null if the file is not checked out.

Throws:

CwException

getCheckOutDate

public java.util.Date getCheckOutDate()
                               throws CwException

Returns the user that has the file checked out, or null if the file is not checked out.

Throws:

CwException

isAutoVersioned

public boolean isAutoVersioned()
                        throws CwException

Return whether the current file is auto-versioned.

Throws:

CwException

isCheckedOut

public boolean isCheckedOut()
                     throws CwException

Returns true if the item is currently checked out.

Throws:

CwException

isVersioned

public boolean isVersioned()
                    throws CwException

This method should only be called when the isWorkingCopy var is being initialized from the Files backend store. Therefore, there is no need for the checks in performInitializationIfNecessary(). If a setIsWorkingCopy method is ever required, it should be added (checking performInitializationIfNecessary). Return whether the current file is versioned. Note that it is possible for m_isVersioned to have been initialized to null (for example, if the item was retrieved using the LIST_FOLDER_ATTRIBUTES attribute set). If this is the case, set the reinitialize flag to trigger the reinitialization.

Throws:

CwException

isVersionEnabled

public boolean isVersionEnabled()
                         throws CwException

Return whether the current file is version-enabled.

Throws:

CwException