oracle.webcenter.peopleconnections.wall

Interface Wall

All Known Subinterfaces:

ScopeWall, UserWall

public interface Wall

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Wall.MESSAGE_TYPE
static class	Wall.Sort
static class	Wall.Visibility

Method Summary

Modifier and Type	Method and Description
WallMessage	addMessage(java.lang.String message) Add a new message to Message Board of user in context.
WallMessage	addMessage(java.lang.String message, boolean isPrivate) Add a new message to Message Board of user in context.
WallMessage	addMessage(java.lang.String message, oracle.webcenter.framework.richtext.RichLink link) Add a new message to Message Board of user in context.
WallMessage	addMessage(java.lang.String message, java.lang.String visibilityType, oracle.webcenter.framework.richtext.RichLink link) Add a new message to Message Board of user in context.
void	deleteMessage(java.lang.String messageId) Delete a particular message from Message Board of user in context.
WallMessage	getMessage(java.lang.String messageId) Returns the Message for a given message Id.
java.util.List<WallMessage>	getMessages(int startIndex, int fetchSize) Deprecated. use the getMessages(int startIndex, int fetchSize, String sortKeyStr, Date dateFrom, Date dateTo)
java.util.List<WallMessage>	getMessages(int startIndex, int fetchSize, java.lang.String sortKeyStr, java.util.Date dateFrom, java.util.Date dateTo) Deprecated.
java.util.List<WallMessage>	getMessages(int startIndex, int fetchSize, java.lang.String sortKeyStr, java.util.Date dateFrom, java.util.Date dateTo, boolean fetchHidden) Retreive a sorted list of messages on the Message Board with in a given date range.
java.util.List<WallMessage>	getMessages(int startIndex, int fetchSize, java.lang.String sortKeyStr, java.util.Date dateFrom, java.util.Date dateTo, boolean fetchHidden, java.lang.String messageType) Retreive a sorted list of messages on the Message Board with in a given date range and visibility.
boolean	isAddMessagesAllowed() Determine if new messages can be added or not.
boolean	isMessagesViewable() Determine if messages are viewable or not.
void	updateMessage(java.lang.String messageId, java.lang.String newMessage) Update a particular message on the Message Board of user in context.
void	updateMessageVisibility(java.lang.String messageId, java.lang.String visibilityStr) Hide or Unhide a particular message from Message Board of user in context.

Method Detail

isMessagesViewable

boolean isMessagesViewable()
                    throws WallServiceException

Determine if messages are viewable or not.

Returns:

true if current logged in user can see the messages of user in context or else false

Throws:

WallServiceException

isAddMessagesAllowed

boolean isAddMessagesAllowed()
                      throws WallServiceException

Determine if new messages can be added or not.

Returns:

true if current logged in user can add messages to user in context or else false

Throws:

WallServiceException

addMessage

WallMessage addMessage(java.lang.String message)
                throws WallServiceException

Add a new message to Message Board of user in context.

Parameters:

message - message string

Returns:

a message object representing newly added message to the Message Board of the user in context.

Throws:

WallServiceException

addMessage

WallMessage addMessage(java.lang.String message,
                       boolean isPrivate)
                throws WallServiceException

Add a new message to Message Board of user in context.

Parameters:

message - message string

isPrivate - if true, message is marked as private, otherwise public

Returns:

a message object representing newly added message to the Message Board of the user in context.

Throws:

WallServiceException

addMessage

WallMessage addMessage(java.lang.String message,
                       oracle.webcenter.framework.richtext.RichLink link)
                throws WallServiceException

Add a new message to Message Board of user in context.

Parameters:

message - message string

link - the link being published.

Returns:

a message object representing newly added message to the Message Board of the user in context.

Throws:

WallServiceException

addMessage

WallMessage addMessage(java.lang.String message,
                       java.lang.String visibilityType,
                       oracle.webcenter.framework.richtext.RichLink link)
                throws WallServiceException

Add a new message to Message Board of user in context.

Parameters:

message - message string

visibilityType - visibilityType of the message to be added

link - the link being published.

Returns:

a message object representing newly added message to the Message Board of the user in context.

Throws:

WallServiceException

deleteMessage

void deleteMessage(java.lang.String messageId)
            throws WallServiceException

Delete a particular message from Message Board of user in context.

Parameters:

messageId - ID of the message

Throws:

WallServiceException

updateMessage

void updateMessage(java.lang.String messageId,
                   java.lang.String newMessage)
            throws WallServiceException

Update a particular message on the Message Board of user in context.

Parameters:

messageId - ID of the message

Throws:

WallServiceException

updateMessageVisibility

void updateMessageVisibility(java.lang.String messageId,
                             java.lang.String visibilityStr)
                      throws WallServiceException

Hide or Unhide a particular message from Message Board of user in context.

Parameters:

messageId - ID of the message

visibilityStr - String literal to toggle hide and unhide

PUBLIC - unhide the message

PRIVATE - hide the message

Throws:

WallServiceException

getMessage

WallMessage getMessage(java.lang.String messageId)
                throws WallServiceException

Returns the Message for a given message Id.

Parameters:

messageId - - the identifier of the message to be returned.

Returns:

the message object for the given identifier

Throws:

WallServiceException - thrown if the message is not found or some error encountered by the service.

getMessages

java.util.List<WallMessage> getMessages(int startIndex,
                                        int fetchSize)
                                 throws WallServiceException

Deprecated. use the getMessages(int startIndex, int fetchSize, String sortKeyStr, Date dateFrom, Date dateTo)

Retreive a list of messages on the Message Board of the user in context. Range and count of messages retreived can be controlled by passing in appropriate startIndex and fetchSize parameters.

Parameters:

startIndex - starting index of the items to include in the retreived list. 0 is the starting index.

fetchSize - count of messages to be retreived. Pass -1 to retrieve all with out any limit.

Returns:

list of messages from Message Board of user in context.

Throws:

WallServiceException

getMessages

java.util.List<WallMessage> getMessages(int startIndex,
                                        int fetchSize,
                                        java.lang.String sortKeyStr,
                                        java.util.Date dateFrom,
                                        java.util.Date dateTo,
                                        boolean fetchHidden)
                                 throws WallServiceException

Retreive a sorted list of messages on the Message Board with in a given date range. Range and count of messages retreived can be controlled by passing in appropriate startIndex and fetchSize parameters.

Parameters:

startIndex - starting index of the items to include in the retreived list. 0 is the starting index.

fetchSize - count of messages to be retreived. Pass -1 to retrieve all with out any limit.

sortKeyStr - String literal for the sort attribute.

DATE - sort by messages posted date

USER - sort by user name of the persons who posted on Message Board

dateFrom - retreive message received from this date. Pass null if no start date filtering is needed.

dateTo - retreive messages received until this date. Pass (@code null} if no end date filtering is needed.

fetchHidden - if true, retrieves the hidden messages also for a given owner. If false, messages hidden by the user are not retrieved.

Returns:

list of messages from Message Board of user in context.

Throws:

WallServiceException

getMessages

java.util.List<WallMessage> getMessages(int startIndex,
                                        int fetchSize,
                                        java.lang.String sortKeyStr,
                                        java.util.Date dateFrom,
                                        java.util.Date dateTo)
                                 throws WallServiceException

Deprecated.

Retrieve a sorted list of messages.

Throws:

WallServiceException

getMessages

java.util.List<WallMessage> getMessages(int startIndex,
                                        int fetchSize,
                                        java.lang.String sortKeyStr,
                                        java.util.Date dateFrom,
                                        java.util.Date dateTo,
                                        boolean fetchHidden,
                                        java.lang.String messageType)
                                 throws WallServiceException

Retreive a sorted list of messages on the Message Board with in a given date range and visibility. Range and count of messages retreived can be controlled by passing in appropriate startIndex and fetchSize parameters.

Parameters:

startIndex - starting index of the items to include in the retreived list. 0 is the starting index.

fetchSize - count of messages to be retreived. Pass -1 to retrieve all with out any limit.

sortKeyStr - String literal for the sort attribute.

DATE - sort by messages posted date

USER - sort by user name of the persons who posted on Message Board

dateFrom - retreive message received from this date. Pass null if no start date filtering is needed.

dateTo - retreive messages received until this date. Pass (@code null} if no end date filtering is needed.

fetchHidden - if true, retrieves the hidden messages also for a given owner. If false, messages hidden by the user are not retrieved.

messageType - Type of MessageType to be shown.

• ALL - all messages.
• PUBLIC - only public messages.
• PRIVATE - only private messages.

Returns:

list of messages from Message Board of user in context.

Throws:

WallServiceException