Oracle® Collaboration Suite Workspaces API Reference
10g (10.1.1.0.2)

Part No. B16233-01


oracle.workspaces.resource.discussion
Class CwMessageProperties

java.lang.Object
  extended byoracle.workspaces.resource.CwResourceItemProperties
      extended byoracle.workspaces.resource.discussion.CwMessageProperties

All Implemented Interfaces:
CwEntityProperties, CwExceptionConstants
Direct Known Subclasses:
CwSearchResultMessageProperties

public class CwMessageProperties
extends CwResourceItemProperties
implements CwExceptionConstants

All the properties of a Workspace message are in this class.

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
javax.mail.BodyPart[] getAttachmentBodyParts()
Returns an array of BodyPart objects for the attachments included in this message.
java.lang.String getBoardName()
Returns the name of the parent board of the message.
CwUid getBoardUid()
Returns the CwUid of the parent board of the message.
java.lang.String getBodyPlainText()
Returns the message body text as a plain text String.
java.lang.Object getBodyRichText()
Returns a Part or a Multipart object for the message containing the rich text representation of this message.
java.lang.String getContentType()
Returns the content type of the message.
java.lang.String getDescription()
A CwMessage resource item does not have the concept of a "description"; therefore this method throws UnsupportedOperationException.
javax.mail.Flags getFlags()
Returns any Flags which are set for the message.
javax.mail.Address[] getFromAddresses()
Returns the from addresses of the message.
CwUser getLastModifiedBy()
Returns the user who last modified the message.
int getLevelInThread()
Returns the level of the message within its containing thread.
java.lang.String getName()
A CwMessage resource item does not have the concept of a "name"; therefore this method throws UnsupportedOperationException.
CwUser getOwner()
A CwMessage resource item does not have the concept of an "owner"; therefore this method throws UnsupportedOperationException.
java.lang.Object getRawContent()
Returns the result of performing a getContent() call on the underlying JavaMail message.
java.util.Date getSentDate()
Returns the Date on which the message was sent.
int getSize()
Returns the size of the message in bytes.
java.lang.String getSubject()
Returns the subject of the message.
CwUid getThreadUid()
Returns the CwUid of the parent thread of the message.
java.lang.String getXPriority()
Returns the priority of the message.
boolean hasAttachments()
Returns whether the message has any attachments.
void setDescription(java.lang.String szDescription)
A CwMessage resource item does not have the concept of a "description"; therefore this method throws UnsupportedOperationException.
void setName(java.lang.String szName)
A CwMessage resource item does not have the concept of a "name"; therefore this method throws UnsupportedOperationException.

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

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

Method Detail

getAttachmentBodyParts

public javax.mail.BodyPart[] getAttachmentBodyParts()
Returns an array of BodyPart objects for the attachments included in this message. Note: if no attachments are present, will return null.

getBoardName

public java.lang.String getBoardName()
Returns the name of the parent board of the message.

getBoardUid

public CwUid getBoardUid()
Returns the CwUid of the parent board of the message.

getBodyPlainText

public java.lang.String getBodyPlainText()
Returns the message body text as a plain text String.

getBodyRichText

public java.lang.Object getBodyRichText()
Returns a Part or a Multipart object for the message containing the rich text representation of this message.

getContentType

public java.lang.String getContentType()
Returns the content type of the message.

getDescription

public java.lang.String getDescription()
                                throws CwException
A CwMessage resource item does not have the concept of a "description"; therefore this method throws UnsupportedOperationException.
Overrides:
getDescription in class CwResourceItemProperties
Throws:
CwException

getFlags

public javax.mail.Flags getFlags()
Returns any Flags which are set for the message. Note that TD includes user-specified flags (Strings) identified by the following constants: CwDiscussionResource.NEW_SINCE_LAST_VISIT_FLAG and CwDiscussionResource.NEW_SINCE_SESSION_FLAG.

getFromAddresses

public javax.mail.Address[] getFromAddresses()
Returns the from addresses of the message.

getLastModifiedBy

public CwUser getLastModifiedBy()
                         throws CwException
Returns the user who last modified the message.
Overrides:
getLastModifiedBy in class CwResourceItemProperties
Throws:
CwException

getLevelInThread

public int getLevelInThread()
Returns the level of the message within its containing thread.

getName

public java.lang.String getName()
                         throws CwException
A CwMessage resource item does not have the concept of a "name"; therefore this method throws UnsupportedOperationException.
Overrides:
getName in class CwResourceItemProperties
Throws:
CwException

getOwner

public CwUser getOwner()
                throws CwException
A CwMessage resource item does not have the concept of an "owner"; therefore this method throws UnsupportedOperationException.
Overrides:
getOwner in class CwResourceItemProperties
Throws:
CwException

getRawContent

public java.lang.Object getRawContent()
Returns the result of performing a getContent() call on the underlying JavaMail message. Return value could be String, InputStream, Multipart, etc. Use the information returned by hasAttachments() and getAttachmentInfo() to determine whether attachments need to be processed, and then process this content. Note: if hasAttachments() is true, it is guaranteed that this method will return an object of type javax.mail.Multipart (or a subclass).
See Also:
javax.mail.Part.getContent(), Multipart

getSentDate

public java.util.Date getSentDate()
Returns the Date on which the message was sent.

getSize

public int getSize()
Returns the size of the message in bytes.

getSubject

public java.lang.String getSubject()
Returns the subject of the message.

getThreadUid

public CwUid getThreadUid()
Returns the CwUid of the parent thread of the message.

getXPriority

public java.lang.String getXPriority()
Returns the priority of the message.

hasAttachments

public boolean hasAttachments()
Returns whether the message has any attachments.

setDescription

public void setDescription(java.lang.String szDescription)
                    throws CwException
A CwMessage resource item does not have the concept of a "description"; therefore this method throws UnsupportedOperationException.
Overrides:
setDescription in class CwResourceItemProperties
Parameters:
szDescription - description of the item.
Throws:
CwException

setName

public void setName(java.lang.String szName)
             throws CwException
A CwMessage resource item does not have the concept of a "name"; therefore this method throws UnsupportedOperationException.
Overrides:
setName in class CwResourceItemProperties
Parameters:
szName - the name of the resource item
Throws:
CwException

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