oracle.workspaces.resource
Class CwResourceItem

java.lang.Object
oracle.workspaces.resource.CwResourceItem

All Implemented Interfaces:

CwAttachmentEnabled, CwEntity, CwExceptionConstants

Direct Known Subclasses:

CwAnnouncement, CwBoard, CwCalendarResourceItem, CwDiscussionResourceItem, CwFilesResourceItem, CwMessage, CwThread, CwView

public abstract class CwResourceItem

extends java.lang.Object

implements CwExceptionConstants, CwAttachmentEnabled, CwEntity

Interface that represents the object item within a CwResource.

Since:

release specific (what release of product did this appear in)

Field Summary

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

void	addAttachments(CwAttachmentDefinition attachmentDef) Sets the properties object for this resource item
CwResourceItemProperties	getProperties() Gets the item properties object.
CwResource	getResource() Returns the resource instance that owns this item.
CwUid	getUid() Load it from properties directly
CwWorkspace	getWorkspace() Returns the workspace that this item belongs to.
boolean	isNew() returns true if and only if getCreatedTime() > getLastAccessTime()
boolean	isNew(java.util.Date startTime) returns true if and only if isNew() and getCreatedTime() > startTime
boolean	isUnread() returns true if and only if getLastModificationTime() > getLastAccessTime()
boolean	isUnread(java.util.Date startTime) returns true if and only if isUnread() and getLastModificationTime() > startTime
CwAttachedEntity[]	listAllAttachments() The result is sorted by attachment type
java.util.Map	listAllAttachmentsByType() Return a Map of all attached items grouped by type; CwEntityType -> CwAttachedEntity[].
CwAttachedEntity[]	listAttachments() The result is sorted by attachment type
java.util.Map	listAttachmentsByType() Return a Map of "target" attachments grouped by type; CwEntityType -> CwAttachedEntity[].
CwAttachedEntity[]	listSourceAttachments() The result is sorted by attachment type
java.util.Map	listSourceAttachmentsByType() Return a Map of "source" attachments grouped by type; CwEntityType -> CwAttachedEntity[].
void	removeAttachments(CwAttachedEntity[] attachments) Remove the specified attachments.
void	removeAttachments(CwUid[] attachmentUids) Remove the specified attachments.
void	storeProperties() Store the properties to backend storage.
boolean	supportsCreatedTime()
void	updateAttachments(CwAttachedEntity[] attachments) Update the attachments for this object to include changes made to the entities; notably changes to the description(s).
void	updateAttachments(CwUid[] attachmentUids, java.lang.String[] newDescriptions) Update attachments for the specified CwUids to have the specified descriptions.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addAttachments

public void addAttachments(CwAttachmentDefinition attachmentDef)
                    throws CwException

Sets the properties object for this resource item

Specified by:

addAttachments in interface CwAttachmentEnabled

Throws:

CwException

getProperties

public CwResourceItemProperties getProperties()
                                       throws CwException

Gets the item properties object. NOTE: Subclasses may need to overwrite this method if lazy approach is implemented upon properties.

Throws:

CwException

getResource

public CwResource getResource()

Returns the resource instance that owns this item.

getUid

public CwUid getUid()

Load it from properties directly

getWorkspace

public CwWorkspace getWorkspace()

Returns the workspace that this item belongs to.

isNew

public boolean isNew()
              throws CwException

returns true if and only if getCreatedTime() > getLastAccessTime()

Specified by:

isNew in interface CwEntity

Throws:

CwException

isNew

public boolean isNew(java.util.Date startTime)
              throws CwException

returns true if and only if isNew() and getCreatedTime() > startTime

Specified by:

isNew in interface CwEntity

Throws:

CwException

isUnread

public boolean isUnread()
                 throws CwException

returns true if and only if getLastModificationTime() > getLastAccessTime()

Specified by:

isUnread in interface CwEntity

Throws:

CwException

isUnread

public boolean isUnread(java.util.Date startTime)
                 throws CwException

returns true if and only if isUnread() and getLastModificationTime() > startTime

Specified by:

isUnread in interface CwEntity

Throws:

CwException

listAllAttachments

public CwAttachedEntity[] listAllAttachments()
                                      throws CwException

The result is sorted by attachment type

Specified by:

listAllAttachments in interface CwAttachmentEnabled

Throws:

CwException

listAllAttachmentsByType

public java.util.Map listAllAttachmentsByType()
                                       throws CwException

Description copied from interface: CwAttachmentEnabled

Return a Map of all attached items grouped by type; CwEntityType -> CwAttachedEntity[].

Specified by:

listAllAttachmentsByType in interface CwAttachmentEnabled

Throws:

CwException

listAttachments

public CwAttachedEntity[] listAttachments()
                                   throws CwException

The result is sorted by attachment type

Specified by:

listAttachments in interface CwAttachmentEnabled

Throws:

CwException

listAttachmentsByType

public java.util.Map listAttachmentsByType()
                                    throws CwException

Description copied from interface: CwAttachmentEnabled

Return a Map of "target" attachments grouped by type; CwEntityType -> CwAttachedEntity[].

Specified by:

listAttachmentsByType in interface CwAttachmentEnabled

Throws:

CwException

listSourceAttachments

public CwAttachedEntity[] listSourceAttachments()
                                         throws CwException

The result is sorted by attachment type

Specified by:

listSourceAttachments in interface CwAttachmentEnabled

Throws:

CwException

listSourceAttachmentsByType

public java.util.Map listSourceAttachmentsByType()
                                          throws CwException

Description copied from interface: CwAttachmentEnabled

Return a Map of "source" attachments grouped by type; CwEntityType -> CwAttachedEntity[].

Specified by:

listSourceAttachmentsByType in interface CwAttachmentEnabled

Throws:

CwException

removeAttachments

public void removeAttachments(CwAttachedEntity[] attachments)
                       throws CwException

Description copied from interface: CwAttachmentEnabled

Remove the specified attachments. Note that this removes the attachment relationship but not the actual item.

Specified by:

removeAttachments in interface CwAttachmentEnabled

Throws:

CwException

removeAttachments

public void removeAttachments(CwUid[] attachmentUids)
                       throws CwException

Description copied from interface: CwAttachmentEnabled

Remove the specified attachments. Note that this removes the attachment relationship but not the actual item.

Specified by:

removeAttachments in interface CwAttachmentEnabled

Throws:

CwException

storeProperties

public void storeProperties()
                     throws CwException

Store the properties to backend storage.

Throws:

CwException

supportsCreatedTime

public boolean supportsCreatedTime()

updateAttachments

public void updateAttachments(CwAttachedEntity[] attachments)
                       throws CwException

Description copied from interface: CwAttachmentEnabled

Update the attachments for this object to include changes made to the entities; notably changes to the description(s).

Specified by:

updateAttachments in interface CwAttachmentEnabled

Throws:

CwException

updateAttachments

public void updateAttachments(CwUid[] attachmentUids,
                              java.lang.String[] newDescriptions)
                       throws CwException

Description copied from interface: CwAttachmentEnabled

Update attachments for the specified CwUids to have the specified descriptions.

Specified by:

updateAttachments in interface CwAttachmentEnabled

Throws:

CwException