|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.9.0) E15995-08 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Wall
Nested Class Summary | |
---|---|
static class |
Wall.MESSAGE_TYPE |
static class |
Wall.Sort |
static class |
Wall.Visibility |
Method Summary | |
---|---|
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 |
---|
boolean isMessagesViewable() throws WallServiceException
WallServiceException
boolean isAddMessagesAllowed() throws WallServiceException
WallServiceException
WallMessage addMessage(java.lang.String message) throws WallServiceException
message
- message stringWallServiceException
WallMessage addMessage(java.lang.String message, boolean isPrivate) throws WallServiceException
message
- message stringisPrivate
- if true, message is marked as private, otherwise publicWallServiceException
WallMessage addMessage(java.lang.String message, oracle.webcenter.framework.richtext.RichLink link) throws WallServiceException
message
- message stringlink
- the link being published.WallServiceException
WallMessage addMessage(java.lang.String message, java.lang.String visibilityType, oracle.webcenter.framework.richtext.RichLink link) throws WallServiceException
message
- message stringvisibilityType
- visibilityType of the message to be addedlink
- the link being published.WallServiceException
void deleteMessage(java.lang.String messageId) throws WallServiceException
messageId
- ID of the messageWallServiceException
void updateMessage(java.lang.String messageId, java.lang.String newMessage) throws WallServiceException
messageId
- ID of the messageWallServiceException
void updateMessageVisibility(java.lang.String messageId, java.lang.String visibilityStr) throws WallServiceException
messageId
- ID of the messagevisibilityStr
- String literal to toggle hide and unhide
WallServiceException
WallMessage getMessage(java.lang.String messageId) throws WallServiceException
messageId
- - the identifier of the message to be returned.WallServiceException
- thrown if the message is not found or some error encountered by the service.java.util.List<WallMessage> getMessages(int startIndex, int fetchSize) throws WallServiceException
getMessages(int startIndex, int fetchSize, String sortKeyStr, Date dateFrom, Date dateTo)
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.WallServiceException
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
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.
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.WallServiceException
java.util.List<WallMessage> getMessages(int startIndex, int fetchSize, java.lang.String sortKeyStr, java.util.Date dateFrom, java.util.Date dateTo) throws WallServiceException
WallServiceException
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
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.
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.
WallServiceException
|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.9.0) E15995-08 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |