net.coalevo.discussion.model
Interface ForumDescriptor

All Known Subinterfaces:

EditableForumDescriptor

public interface ForumDescriptor

Defines the forum descriptor.

Version:

1.0.0 (10/02/2009)

Author:

Dieter Wimberger (wimpi)

Method Summary

long	getCreated() The creation date of the forum.
AgentIdentifier	getCreator() Returns the identifier of the creator of the forum.
ForumIdentifier	getIdentifier() Returns the identifier of the forum.
java.lang.String	getInfoFormat() Returns a string defining the format of the forum info.
java.util.Locale	getLanguage() Returns the locale that defines the forum's language.
int	getMaxActive() Returns the maximum number of active entries.
java.lang.String	getMnemonic() Returns the mnemonic assigned to the forum.
AgentIdentifier	getModerator() Returns the identifier of the moderator of the forum.
long	getModified() The modification date of the forum.
java.lang.String	getName() Returns the forum name.
int	getSequenceNumber() Returns the sequence number of the forum.
java.util.Set<java.lang.String>	getTags() Returns a list of tags attached to thr entry.
boolean	isAnonymousAllowed() Tests if anonymous entries are allowed.
boolean	isInvalidated() Tests if this descriptor is invalidated.
boolean	isInviteOnly() Tests if the forum is invite only.
boolean	isModeratedStrict() Tests if the forum is moderated strictly.
boolean	isPublic() Tests if this forum is public.

Method Detail

getIdentifier

ForumIdentifier getIdentifier()

Returns the identifier of the forum.

Returns:

a ForumIdentifier instance.

getSequenceNumber

int getSequenceNumber()

Returns the sequence number of the forum.

Returns:

a forum sequence number.

getMnemonic

java.lang.String getMnemonic()

Returns the mnemonic assigned to the forum.

Returns:

the forum mnemonic.

getName

java.lang.String getName()

Returns the forum name.

Returns:

the forum name.

getLanguage

java.util.Locale getLanguage()

Returns the locale that defines the forum's language.

Returns:

a Locale defining the forum language.

getCreator

AgentIdentifier getCreator()

Returns the identifier of the creator of the forum.

Returns:

an AgentIdentifier instance.

getModerator

AgentIdentifier getModerator()

Returns the identifier of the moderator of the forum.

Returns:

an AgentIdentifier instance.

getTags

java.util.Set<java.lang.String> getTags()

Returns a list of tags attached to thr entry.

Returns:

a List of String tags.

getInfoFormat

java.lang.String getInfoFormat()

Returns a string defining the format of the forum info.

Returns:

a string defining the info format.

isModeratedStrict

boolean isModeratedStrict()

Tests if the forum is moderated strictly.

Strict moderation means that each entry and comment requires moderator approval.

Returns:

true if moderated strictly, false otherwise.

isAnonymousAllowed

boolean isAnonymousAllowed()

Tests if anonymous entries are allowed.

Returns:

true if allowed, false otherwise.

isInviteOnly

boolean isInviteOnly()

Tests if the forum is invite only.

Invite only means that the moderator has to subscribe users to the forum.

Returns:

true if invite only, false otherwise.

isPublic

boolean isPublic()

Tests if this forum is public.

If the forum is public, this means that it may be accessible by anonymous, non authenticated users. For example by public web access.

Returns:

true if public, false otherwise.

getCreated

long getCreated()

The creation date of the forum.

Returns:

the creation date as UTC timestamp.

getModified

long getModified()

The modification date of the forum.

Returns:

the last modification date as UTC timestamp.

getMaxActive

int getMaxActive()

Returns the maximum number of active entries. If there are more entries in a specific forum, they will be archived by the maintenance mechanism.

Returns:

the number of max. active entries in this forum.

isInvalidated

boolean isInvalidated()

Tests if this descriptor is invalidated.

Returns:

true if invalidated, false otherwise.