Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.base.action
Interface JiveObjectLoader

All Known Implementing Classes:
AnnounceAction, AnnounceDeleteAction, AnnounceEditAction, AnnounceExpireAction, BranchAction, DeleteAction, ForumAction, ForumCategoryAction, ForumThreadAction, LockThreadAction, MoveThreadAction, PollAction, PollDeleteAction, PollEditAction, PollExpireAction, PollPostAction, PollsViewAction, PollViewAction, PollVoteAction, PostAnnounceAction, UnlockThreadAction

public interface JiveObjectLoader

An interface to mark an action as capable of loading a set of objects. This is used to make object loading easier in actions and to enable a common response type when objects fail to load.


Method Summary
 java.lang.String loadObjects()
          Loads objects in an action.
 

Method Detail

loadObjects

java.lang.String loadObjects()
                             throws java.lang.Exception
Loads objects in an action. This method should return Action.SUCCESS if object loading occurred normally. If another type of code is returned then a WebWork interceptor can pick up on that and return a different view page.

Returns:
Action.SUCCESS if object loading occurred normally, anything else to indicate that object loading failed.
Throws:
java.lang.Exception - if an unexpected error occurs when loading the objects.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.