oracle.workspaces.resource.files
Class CwFilesItemProperties

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

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:

CwFilesItemWithContentProperties, CwFolderProperties

public abstract class CwFilesItemProperties

extends CwResourceItemProperties

implements CwFilesConstants

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	getCreatedBy() Returns the creator.
java.util.Date	getCreatedTime() Get the creation time.
java.lang.String	getDescription() Get the description.
CwUser	getLastModifiedBy() Returns the user that performed the last modification.
java.util.Date	getLastModifiedTime() Get the last modification time.
CwUser	getLockOwner() Return the lock owner, or null if the file is not locked.
java.lang.String	getName() Get the name.
java.lang.String	getParentFolderName() Return the parent folder name without any additional roundtrips to the Files resource.
java.lang.String	getParentFolderPath() Gets the parent's path without incurring another round-trip to the resource.
CwUid	getParentFolderUid() Gets the parent folder's Files ID.
java.lang.String	getPath() Gets the path to this item.
java.lang.String	getUrl() Gets the URL to this item.
long	getWorkspaceAllocatedQuota() Returns the quota allocated to the entire library.
long	getWorkspaceConsumedQuota() Returns the quota consumed by the entire library.
boolean	isInTrashFolder() Returns true is this item is in the trash.
boolean	isLocked() Returns whether or not the current file is locked.
void	setDescription(java.lang.String description) Override parent setDescription, so we can check to see if initialization needs to be done first.
void	setName(java.lang.String name) Override parent setName, so we can check to see if initialization needs to be done first.

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

getCreatedBy

public CwUser getCreatedBy()
                    throws CwException

Returns the creator.

Throws:

CwException

getCreatedTime

public java.util.Date getCreatedTime()
                              throws CwException

Get the creation time. Override the parent, so we can check if init needs to be done.

Specified by:

getCreatedTime in interface CwEntityProperties

Overrides:

getCreatedTime in class CwResourceItemProperties

Throws:

CwException

getDescription

public java.lang.String getDescription()
                                throws CwException

Get the description. Override the parent, so we can check if init needs to be done.

Overrides:

getDescription in class CwResourceItemProperties

Throws:

CwException

getLastModifiedBy

public CwUser getLastModifiedBy()
                         throws CwException

Returns the user that performed the last modification.

Overrides:

getLastModifiedBy in class CwResourceItemProperties

Throws:

CwException

getLastModifiedTime

public java.util.Date getLastModifiedTime()
                                   throws CwException

Get the last modification time. Override the parent, so we can check if init needs to be done.

Specified by:

getLastModifiedTime in interface CwEntityProperties

Overrides:

getLastModifiedTime in class CwResourceItemProperties

Throws:

CwException

getLockOwner

public CwUser getLockOwner()
                    throws CwException

Return the lock owner, or null if the file is not locked.

Throws:

CwException

getName

public java.lang.String getName()
                         throws CwException

Get the name. Override the parent, so we can check if init needs to be done.

Overrides:

getName in class CwResourceItemProperties

Throws:

CwException

getParentFolderName

public java.lang.String getParentFolderName()
                                     throws CwException

Return the parent folder name without any additional roundtrips to the Files resource.

Throws:

CwException

getParentFolderPath

public java.lang.String getParentFolderPath()
                                     throws CwException

Gets the parent's path without incurring another round-trip to the resource.

Throws:

CwException

getParentFolderUid

public CwUid getParentFolderUid()
                         throws CwException

Gets the parent folder's Files ID. Note that it is possible for the parent UID 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

getPath

public java.lang.String getPath()
                         throws CwException

Gets the path to this item.

Throws:

CwException

getUrl

public java.lang.String getUrl()
                        throws CwException

Gets the URL to this item.

Throws:

CwException

getWorkspaceAllocatedQuota

public long getWorkspaceAllocatedQuota()

Returns the quota allocated to the entire library.

getWorkspaceConsumedQuota

public long getWorkspaceConsumedQuota()

Returns the quota consumed by the entire library.

isInTrashFolder

public boolean isInTrashFolder()
                        throws CwException

Returns true is this item is in the trash. The item may be several levels down within the trash folder, e.g. .../Trash/Folder1/Folder2/Item. The trash folder itself returns false, as it cannot be in itself.

Throws:

CwException

isLocked

public boolean isLocked()
                 throws CwException

Returns whether or not the current file is locked.

Returns:

true if the item is currently checked out, false otherwise.

Throws:

CwException

setDescription

public void setDescription(java.lang.String description)
                    throws CwException

Override parent setDescription, so we can check to see if initialization needs to be done first.

Overrides:

setDescription in class CwResourceItemProperties

Parameters:

description - description of the item.

Throws:

CwException

setName

public void setName(java.lang.String name)
             throws CwException

Override parent setName, so we can check to see if initialization needs to be done first.

Overrides:

setName in class CwResourceItemProperties

Parameters:

name - the name of the resource item

Throws:

CwException