Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface JournalsLibrary.ForumJournal

Enclosing interface:

JournalsLibrary

public static interface JournalsLibrary.ForumJournal

Journals with a meta-flags entry, typically Forums, are described by the accessors of this interface. ForumJournals are a type of Journal that is accessed via the web.

Method Summary

Modifier and Type	Method	Description
java.lang.String	adminMask()	Returns the raw zapper mask for administering
java.lang.String	attachMask()	Returns the raw zapper mask for attaching
boolean	authorizationCheck(MOB M, JournalsLibrary.ForumJournalFlags fl)	Returns whether the given mob is authorized to do the task designated by the given flag, typically by calling maskCheck above.
java.lang.String	category()	Returns the category this journal is in
java.lang.String	getFlag(JournalsLibrary.ForumJournalFlags flag)	Returns the value of a forum journal flag
boolean	maskCheck(MOB M, java.lang.String mask)	Returns whether the given mob passes the given zapper mask, presumably one of the above.
int	maxAttach()	Returns the maximum attachments
java.lang.String	NAME()	Returns the journal name
java.lang.String	postMask()	Returns the raw zapper mask for posting
java.lang.String	readMask()	Returns the raw zapper mask for reading
java.lang.String	replyMask()	Returns the raw zapper mask for replying

Method Detail

NAME

java.lang.String NAME()

Returns the journal name

Returns:

the journal name

category

java.lang.String category()

Returns the category this journal is in

Returns:

the category this journal is in

readMask

java.lang.String readMask()

Returns the raw zapper mask for reading

Returns:

the raw zapper mask for reading

postMask

java.lang.String postMask()

Returns the raw zapper mask for posting

Returns:

the raw zapper mask for posting

replyMask

java.lang.String replyMask()

Returns the raw zapper mask for replying

Returns:

the raw zapper mask for replying

attachMask

java.lang.String attachMask()

Returns the raw zapper mask for attaching

Returns:

the raw zapper mask for attaching

maxAttach

int maxAttach()

Returns the maximum attachments

Returns:

the maximum attachments

adminMask

java.lang.String adminMask()

Returns the raw zapper mask for administering

Returns:

the raw zapper mask for administering

getFlag

java.lang.String getFlag(JournalsLibrary.ForumJournalFlags flag)

Returns the value of a forum journal flag

Parameters:

flag - the flag to return

Returns:

the value of the flag or null

See Also:

JournalsLibrary.ForumJournalFlags

maskCheck

boolean maskCheck(MOB M,
                  java.lang.String mask)

Returns whether the given mob passes the given zapper mask, presumably one of the above. It might seem wasteful, but remember that the masking library caches stuff like this.

Parameters:

M - the mob to check

mask - the mask to check them against

Returns:

true if the mob passes, false otherwise

authorizationCheck

boolean authorizationCheck(MOB M,
                           JournalsLibrary.ForumJournalFlags fl)

Returns whether the given mob is authorized to do the task designated by the given flag, typically by calling maskCheck above.

Parameters:

M - the mob to check

fl - an appropriate flag

Returns:

true if the mob is authorized, false otherwise

See Also:

JournalsLibrary.ForumJournalFlags