oracle.discussions.sdk
Class TdAnnotation

java.lang.Object
oracle.discussions.sdk.TdAnnotation

public class TdAnnotation

extends java.lang.Object

Represents any operations that are performed on the threads/messages in oracle discussions. Holds the user performing the operation, operation begin performed, date on which the operation is being performed, and other arguments.

Oracle discussions elements names have been changed in the webui compared to that of sdk portion. The existing names to the new names mapping is as shown.

• Facility - Category
• Board - Forum
• Delete - Hide

Sample code snippet illustrating the usage of TdAnnotation

 //Code snippet below illustrated the thread moving from one board to another.
 TdThread newThread = tdbTo.getThread(getOracleThreadId());
 // add annotation for the move
 MessageUtils.addAnnotation(newThread, TdAnnotation.createInstance(new java.util.Date(), _tdsession.getTdUser(),
                                                            TdOperation.TD_MOVE_MESSAGE,
                                                            _tdb.getFullPath() + " " + tdbTo.getFullPath()));
 

Since:

OCS 10.1.1

See Also:

TdMessage.java

Method Summary

static TdAnnotation	createInstance(java.util.Date dte, TdUser tdUser, oracle.discussions.sdk.impl.TdOperation tdOp, java.lang.String args) Creates an instance of TdAnnotation, taking in date, td user, operation and args.
java.lang.String	getArguments() Returns the arguments of the annotation.
oracle.discussions.sdk.impl.TdOperation	getTdOperation() Returns the operation of the annotation
TdUser	getTdUser() Returns the user in the annotation
java.util.Date	getTime() Returns the date in the annotation

Methods inherited from class java.lang.Object

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

Method Detail

createInstance

public static TdAnnotation createInstance(java.util.Date dte,
                                          TdUser tdUser,
                                          oracle.discussions.sdk.impl.TdOperation tdOp,
                                          java.lang.String args)

Creates an instance of TdAnnotation, taking in date, td user, operation and args.

Parameters:

tdUser - the user who is working on the message

tdOp - oracle discussions operation which is annotated.

args - arguments

Returns:

TdAnnotation

getTime

public java.util.Date getTime()

Returns the date in the annotation

Returns:

Date

getTdUser

public TdUser getTdUser()

Returns the user in the annotation

Returns:

TdUser

getTdOperation

public oracle.discussions.sdk.impl.TdOperation getTdOperation()

Returns the operation of the annotation

Returns:

TdOperation

getArguments

public java.lang.String getArguments()

Returns the arguments of the annotation.

Returns:

String