|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.confluence.content.service.NotationHelpBookmarkCommand
public class NotationHelpBookmarkCommand
Stores a User's current section in notation help.
Constructor Summary | |
---|---|
NotationHelpBookmarkCommand(String section)
|
Method Summary | |
---|---|
void |
execute()
Execute the command. |
String |
getSection()
|
Collection<ValidationError> |
getValidationErrors()
Gets the list of errors that are preventing the command from being executed. |
boolean |
isAuthorized()
Determine if the current user is authorized to execute this command. |
boolean |
isValid()
Determine if the command is in a valid state to be executed. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public NotationHelpBookmarkCommand(String section)
Method Detail |
---|
public boolean isValid()
ServiceCommand
ServiceCommand.execute()
is be expected to perform successfully (unless prevented by some system
error). If this method returns false, execute
will fail with a
NotValidException
.
This method should be called after checking ServiceCommand.isAuthorized()
. If the current user is not
authorized to execute this command, this method must throw a NotAuthorizedException
.
If this method returns false, then ServiceCommand.getValidationErrors()
must return a non-empty list of
errors explaining why the command was not valid. If this method returns true, the collection returned by
getValidationErrors()
must be empty.
isValid
in interface ServiceCommand
public Collection<ValidationError> getValidationErrors()
ServiceCommand
ServiceCommand.isValid()
will always return an empty collection.
getValidationErrors
in interface ServiceCommand
ValidationError
objects describing why command validation failedpublic boolean isAuthorized()
ServiceCommand
AuthenticatedUserThreadLocal.getUser()
.
isAuthorized
in interface ServiceCommand
public void execute()
ServiceCommand
execute
in interface ServiceCommand
public String getSection()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |