oracle.workspaces.resource.discussion
Class CwBoardProperties
java.lang.Object
oracle.workspaces.resource.CwResourceItemProperties
oracle.workspaces.resource.discussion.CwBoardProperties
- All Implemented Interfaces:
- CwEntityProperties, CwExceptionConstants
- public class CwBoardProperties
- extends CwResourceItemProperties
- implements CwExceptionConstants
The properties of a CwBoard. This object can be retrieved from a CwBoard and can be used to change board properties persistently with the storeProperties() method.
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 |
java.lang.String |
getBeginQuotePrefix()
Returns the prefix to use at the start of a quotation in a message reply for the board. |
int |
getBoardEditDeletePolicy()
Returns an int constant which specifies the board policy for editing and deleting messages. |
java.lang.String |
getDescription()
Returns the description of the board. |
java.lang.String |
getDisplayName()
Gets display name for the board. |
java.lang.String |
getEmailAddress()
Returns the board email address. |
int |
getEmailInboundPolicy()
Returns the board setting for BoardEmailInboundPolicy. |
javax.mail.Flags |
getFlags()
Gets flags for the board; of particular interest are the flags for "new since last visit" and "new since session". |
CwUser |
getLastModifiedBy()
Returns the user who last posted to or otherwise modified the board. |
javax.mail.Address |
getLastModifier()
Returns the email address of the last person to modify the board. |
int |
getMessageCount()
Returns the number of messages in the board. |
int |
getNewMessageCount()
Returns the number of new messages in the board. |
java.lang.String |
getSubjectReplyPrefix()
Returns the prefix to be automatically affixed to the subject line of a reply message for the board. |
int |
getThreadCount()
Returns the number of threads in the board. |
int |
getUnreadMessageCount()
Returns the number of unread messages in the board. |
boolean |
hasNewMessages()
Returns a boolean indicating whether the board has any new messages. |
boolean |
isOriginalQuoted()
Returns a boolean indicating whether the original message should be quoted in a reply for the board. |
void |
setBeginQuotePrefix(java.lang.String szPrefix)
Sets the prefix to use at the start of each line of quoted text. |
void |
setBoardEditDeletePolicy(int iEditPolicy)
Sets the policy rules for editing messages within this board. |
void |
setDescription(java.lang.String szDescription)
Sets the description of the board. |
void |
setDisplayName(java.lang.String displayName)
Sets display name for the board. |
void |
setEmailAddress(java.lang.String szEmail)
Sets the board email address. |
void |
setEmailInboundPolicy(int iBoardEmailInboundPolicy)
Sets the board setting for BoardEmailInboundPolicy. |
void |
setOriginalQuoted(boolean bOriginalQuoted)
Sets whether the original message should be quoted in a reply on this board. |
void |
setSubjectReplyPrefix(java.lang.String szPrefix)
Sets the reply prefix for the subject line for this board. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
getBeginQuotePrefix
public java.lang.String getBeginQuotePrefix()
throws CwException
- Returns the prefix to use at the start of a quotation in a message reply for the board.
-
- Throws:
CwException
getBoardEditDeletePolicy
public int getBoardEditDeletePolicy()
throws CwException
- Returns an int constant which specifies the board policy for editing and deleting messages. See the constants defined in CwBoard.
-
- Throws:
CwException
getDescription
public java.lang.String getDescription()
throws CwException
- Returns the description of the board.
-
- Overrides:
getDescription
in class CwResourceItemProperties
-
- Throws:
CwException
getDisplayName
public java.lang.String getDisplayName()
throws CwAttrValException
- Gets display name for the board.
-
- Throws:
CwAttrValException
getEmailAddress
public java.lang.String getEmailAddress()
throws CwException
- Returns the board email address.
-
- Throws:
CwException
getEmailInboundPolicy
public int getEmailInboundPolicy()
throws CwException
- Returns the board setting for BoardEmailInboundPolicy. Note: The valid values are public constants in the CwBoard class.
-
- Throws:
CwException
getFlags
public javax.mail.Flags getFlags()
- Gets flags for the board; of particular interest are the flags for "new since last visit" and "new since session". These are user-specified flags (Strings) and are identified by the constants: CwDiscussionResource.NEW_SINCE_LAST_VISIT_FLAG and CwDiscussionResource.NEW_SINCE_SESSION_FLAG.
getLastModifiedBy
public CwUser getLastModifiedBy()
throws CwException
- Returns the user who last posted to or otherwise modified the board.
-
- Overrides:
getLastModifiedBy
in class CwResourceItemProperties
-
- Throws:
CwException
getLastModifier
public javax.mail.Address getLastModifier()
- Returns the email address of the last person to modify the board.
getMessageCount
public int getMessageCount()
- Returns the number of messages in the board.
getNewMessageCount
public int getNewMessageCount()
- Returns the number of new messages in the board. Note that the concept of "new" is relative to the user session that was used to obtain the board object.
getSubjectReplyPrefix
public java.lang.String getSubjectReplyPrefix()
throws CwException
- Returns the prefix to be automatically affixed to the subject line of a reply message for the board.
-
- Throws:
CwException
getThreadCount
public int getThreadCount()
- Returns the number of threads in the board.
getUnreadMessageCount
public int getUnreadMessageCount()
- Returns the number of unread messages in the board. Note that the concept of "unread" is relative to the user session that was used to obtain the board object.
hasNewMessages
public boolean hasNewMessages()
- Returns a boolean indicating whether the board has any new messages. Note that the concept of "new" is relative to the user session that was used to obtain the board object.
isOriginalQuoted
public boolean isOriginalQuoted()
throws CwException
- Returns a boolean indicating whether the original message should be quoted in a reply for the board.
-
- Throws:
CwException
setBeginQuotePrefix
public void setBeginQuotePrefix(java.lang.String szPrefix)
throws CwException
- Sets the prefix to use at the start of each line of quoted text.
-
- Throws:
CwException
setBoardEditDeletePolicy
public void setBoardEditDeletePolicy(int iEditPolicy)
throws CwException
- Sets the policy rules for editing messages within this board.
-
- Parameters:
iEditPolicy
- the int constant from CwBoard which specifies the appropriate policy
- Throws:
CwException
setDescription
public void setDescription(java.lang.String szDescription)
throws CwException
- Sets the description of the board.
-
- Overrides:
setDescription
in class CwResourceItemProperties
-
- Parameters:
szDescription
- description of the item.
- Throws:
CwException
setDisplayName
public void setDisplayName(java.lang.String displayName)
throws CwAttrValException
- Sets display name for the board.
-
- Throws:
CwAttrValException
setEmailAddress
public void setEmailAddress(java.lang.String szEmail)
- Sets the board email address. Note that this can only be done and committed a single time, either during board creation of afterward. Any attempt to reset the email address to a different value will throw an exception upon storeProperties().
setEmailInboundPolicy
public void setEmailInboundPolicy(int iBoardEmailInboundPolicy)
throws CwException
- Sets the board setting for BoardEmailInboundPolicy. Note: The valid values are public constants in the CwBoard class.
-
- Throws:
CwException
setOriginalQuoted
public void setOriginalQuoted(boolean bOriginalQuoted)
throws CwException
- Sets whether the original message should be quoted in a reply on this board.
-
- Throws:
CwException
setSubjectReplyPrefix
public void setSubjectReplyPrefix(java.lang.String szPrefix)
throws CwException
- Sets the reply prefix for the subject line for this board.
-
- Throws:
CwException