oracle.discussions.ws.beans
Class AbstractContainer

java.lang.Object
oracle.discussions.ws.beans.AbstractContainer

Direct Known Subclasses:

Category, Forum

public class AbstractContainer

extends java.lang.Object

Represents properties common to a category and a forum. Used in returning TdContainer sdk objects to client side, as beans.

See Also:

Category, Forum

Method Summary

int	getContainerType() Returns the container type.
java.util.Calendar	getCreationDate() Returns a calendar object representing the container's creation date.
java.lang.String	getCreator() Returns nick name of the creator of this container.
java.lang.String	getDescription() Returns the description of the container.
java.lang.String	getDisplayName() Returns the container's display name in the user's locale.
java.lang.String	getDisplayPath() Returns the absolute display path of the container.
long	getId() Returns the container's id.
LastPost	getLastPost() Returns the latest post information on the current container.
java.lang.String	getName() Returns the container's name.
long	getParentId() Returns the parent container of this container.
java.lang.String	getRssURL() Returns the rss url corresponding to the container's rss feed.
java.lang.String	getWebuiURL() Returns the web page url corresponding to the container.
boolean	isAnnouncementsBoardPresent() Returns if the container has an embedded announcements forum in it.
boolean	isCategoryType() Returns if the container represents a category.
boolean	isFavorite() Returns if the container is in the user's favorite listing.
boolean	isNewFolder() Returns true if, isNewSinceLastVisit or isNewSinceSession is true.
boolean	isNewSinceLastVisit() Returns true, if the container is created, after the user's last logout time.
boolean	isNewSinceSession() Returns true, if the container is created, after the user's current login time.

Methods inherited from class java.lang.Object

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

Method Detail

getContainerType

public int getContainerType()

Returns the container type. Return value of

• 1 if the container is a category
• 2 if the container is a forum

Returns:

int - container type

getCreationDate

public java.util.Calendar getCreationDate()

Returns a calendar object representing the container's creation date.

Returns:

Calendar - container creation date.

getCreator

public java.lang.String getCreator()

Returns nick name of the creator of this container. Returns an empty string "", if the creator of the container is deleted from the OID,

Returns:

String - creator's nickname

getDescription

public java.lang.String getDescription()

Returns the description of the container. Returns null, if the description is not provided during container creation/updation.

Returns:

String - container's description.

getDisplayPath

public java.lang.String getDisplayPath()

Returns the absolute display path of the container.

The absolute path starts with a "/", representing the root container.
For example, if the container is a root container, the display path will be /A, where A is the container display name.
Displayname is used to prepare display path.

Returns:

String - Container's display path

getDisplayName

public java.lang.String getDisplayName()

Returns the container's display name in the user's locale.

Returns:

String - Container's display name

getLastPost

public LastPost getLastPost()

Returns the latest post information on the current container.

The lastpost information includes

• Lastpost author's nickname
• Lastpost forum id
• Lastpost topic id
• lastpost message id
• .

The lastpost information is computed recursively on all the messages under the current container.
Null is returned, if there are no messages under the current container.

Returns:

Lastpost - lastpost information on the current container

isFavorite

public boolean isFavorite()

Returns if the container is in the user's favorite listing. Returns

• true, if the container is in the user's favorite listing
• false, if the container is not in the user's favorite listing

Returns:

boolean - Status indicating if the container is a favorite for this user.

isNewFolder

public boolean isNewFolder()

Returns true if,

• isNewSinceLastVisit
• or
• isNewSinceSession

is true.

Returns:

boolean - Status indicating if the container is new

isNewSinceLastVisit

public boolean isNewSinceLastVisit()

Returns true, if the container is created, after the user's last logout time.

Returns:

boolean - Status indicating if the container is new.

isNewSinceSession

public boolean isNewSinceSession()

Returns true, if the container is created, after the user's current login time.

Returns:

boolean - Status indicating if the container is new.

getName

public java.lang.String getName()

Returns the container's name. A container's name is contstant and will not be localized.

Returns:

String - Container's name.

getRssURL

public java.lang.String getRssURL()

Returns the rss url corresponding to the container's rss feed. If the url is copy-pasted in a browser, the rss feed corresponding to the container can be accessed.

Returns:

String - url representing container's rss feed.

getWebuiURL

public java.lang.String getWebuiURL()

Returns the web page url corresponding to the container. If the url is copy-pasted in a browser, the webpage corresponding to the container can be accessed.

Returns:

String - url representing container's web page feed.

getId

public long getId()

Returns the container's id. Every Discussions element is given a unique number, on its creation. The unique number, called ID, can be used to access the container.

Returns:

long - Container's id.

isCategoryType

public boolean isCategoryType()

Returns if the container represents a category. Returns

• true - if the container represents a category
• false - if the container represents a forum

isAnnouncementsBoardPresent

public boolean isAnnouncementsBoardPresent()

Returns if the container has an embedded announcements forum in it.

Returns true, if the container has an announcements forum, false otherwise.

Returns:

boolean - Status indicating if the container has an announcements forum.

getParentId

public long getParentId()

Returns the parent container of this container.

Returns -1, if the parent container is Discussions root.

Returns:

long - Parent container's id.