You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openmeetings.apache.org by so...@apache.org on 2012/12/05 18:06:03 UTC
svn commit: r1417528 - in
/incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings:
axis/services/ remote/ remote/red5/
Author: solomax
Date: Wed Dec 5 17:06:00 2012
New Revision: 1417528
URL: http://svn.apache.org/viewvc?rev=1417528&view=rev
Log:
Compilation warnings are eliminated
Modified:
incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/axis/services/CalendarWebService.java
incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/axis/services/FileWebService.java
incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/axis/services/RoomWebService.java
incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/axis/services/UserWebService.java
incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/CalendarService.java
incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/ChatService.java
incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/ConferenceLibrary.java
incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/ConferenceService.java
incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/ConfigurationService.java
incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/ErrorService.java
incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/InvitationService.java
incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/LanguageService.java
incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/LdapConfigService.java
incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/MainService.java
incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/OrganisationService.java
incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/UserService.java
incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/WhiteBoardService.java
incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/red5/ScopeApplicationAdapter.java
Modified: incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/axis/services/CalendarWebService.java
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/axis/services/CalendarWebService.java?rev=1417528&r1=1417527&r2=1417528&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/axis/services/CalendarWebService.java (original)
+++ incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/axis/services/CalendarWebService.java Wed Dec 5 17:06:00 2012
@@ -97,7 +97,8 @@ public class CalendarWebService {
* start time, yyyy-mm-dd
* @param endtime
* end time, yyyy-mm-dd
- * @return
+ *
+ * @return - list of appointments in range
*/
public List<Appointment> getAppointmentByRange(String SID, Date starttime,
Date endtime) {
@@ -128,7 +129,8 @@ public class CalendarWebService {
* start time, yyyy-mm-dd
* @param endtime
* end time, yyyy-mm-dd
- * @return
+ *
+ * @return - list of appointments in range
*/
public List<Appointment> getAppointmentByRangeForUserId(String SID,
long userId, Date starttime, Date endtime) {
@@ -153,7 +155,7 @@ public class CalendarWebService {
*
* @param SID
* The SID of the User. This SID must be marked as Loggedin
- * @return
+ * @return - next Calendar event
*/
public Appointment getNextAppointment(String SID) {
@@ -177,7 +179,8 @@ public class CalendarWebService {
*
* @param SID
* The SID of the User. This SID must be marked as Loggedin
- * @return
+ *
+ * @return - next Calendar event
*/
public Appointment getNextAppointmentForUserId(String SID, long userId) {
@@ -203,7 +206,8 @@ public class CalendarWebService {
* The SID of the User. This SID must be marked as Loggedin
* @param appointmentName
* the search string
- * @return
+ *
+ * @return - calendar event list
*/
public List<Appointment> searchAppointmentByName(String SID,
String appointmentName) {
@@ -274,7 +278,8 @@ public class CalendarWebService {
* if the room is password protected
* @param password
* the password for the room
- * @return
+ *
+ * @return - id of appointment saved
*/
public Long saveAppointment(String SID, String appointmentName,
String appointmentLocation, String appointmentDescription,
@@ -341,7 +346,8 @@ public class CalendarWebService {
* the base URL for the invitations that will be send by email
* @param languageId
* the language id
- * @return
+ *
+ * @return - id of appointment updated
*/
public Long updateAppointmentTimeOnly(String SID, Long appointmentId,
Date appointmentstart, Date appointmentend, String baseurl,
@@ -422,7 +428,8 @@ public class CalendarWebService {
* if the room is password protected
* @param password
* the password for the room
- * @return
+ *
+ * @return - id of appointment updated
*/
public Long updateAppointment(String SID, Long appointmentId,
String appointmentName, String appointmentLocation,
@@ -514,7 +521,7 @@ public class CalendarWebService {
* @param language_id
* the language id in which the notifications for the deleted
* appointment are send
- * @return
+ * @return - id of appointment deleted
*/
public Long deleteAppointment(String SID, Long appointmentId,
Long language_id) throws AxisFault {
@@ -556,7 +563,7 @@ public class CalendarWebService {
*
* @param SID
* @param room_id
- * @return
+ * @return - calendar event by its room id
*/
public Appointment getAppointmentByRoomId(String SID, Long room_id) {
try {
@@ -588,7 +595,7 @@ public class CalendarWebService {
* Get all categories of calendar events
*
* @param SID
- * @return
+ * @return - all categories of calendar events
*/
public List<AppointmentCategory> getAppointmentCategoryList(String SID) {
log.debug("AppointmenetCategoryService.getAppointmentCategoryList SID : "
@@ -628,7 +635,7 @@ public class CalendarWebService {
* Get all reminder types for calendar events
*
* @param SID
- * @return
+ * @return - all reminder types for calendar events
*/
public List<AppointmentReminderTyps> getAppointmentReminderTypList(
String SID) {
@@ -682,7 +689,8 @@ public class CalendarWebService {
* href="http://en.wikipedia.org/wiki/Time_zone#Java"
* target="_blank"
* >http://en.wikipedia.org/wiki/Time_zone#Java</a>
- * @return
+ *
+ * @return - appointments grouped by weeks
* @throws AxisFault
*/
public List<Week> getAppointmentsByWeekCalendar(String SID,
Modified: incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/axis/services/FileWebService.java
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/axis/services/FileWebService.java?rev=1417528&r1=1417527&r2=1417528&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/axis/services/FileWebService.java (original)
+++ incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/axis/services/FileWebService.java Wed Dec 5 17:06:00 2012
@@ -106,7 +106,8 @@ public class FileWebService {
* the file goto the private section
* @param fileSystemName
* the filename => Important WITH file extension!
- * @return
+ *
+ * @return - array of file import errors
* @throws AxisFault
*/
public FileImportError[] importFile(String SID, String externalUserId,
@@ -223,7 +224,8 @@ public class FileWebService {
* the file goto the private section
* @param fileSystemName
* the filename => Important WITH file extension!
- * @return
+ *
+ * @return - array of file import errors
* @throws AxisFault
*/
public FileImportError[] importFileByInternalUserId(String SID,
@@ -326,7 +328,8 @@ public class FileWebService {
* the external file-type to identify the file later
* @param externalType
* the name of the external system
- * @return
+ *
+ * @return - id of folder added
* @throws AxisFault
*/
public Long addFolderByExternalUserIdAndType(String SID,
@@ -391,8 +394,9 @@ public class FileWebService {
* @param room_id the room Id, if the file goes to the private folder of an user, you can set a random number here
* @param isOwner specify a 1/true AND parentFolderId==-2 to make the file goto the private section
* @param externalFilesid the external file-type to identify the file later
- * @param externalType the name of the external system
- * @return
+ * @param externalType the name of the external system
+ *
+ * @return - id of the folder
* @throws AxisFault
*/
public Long addFolderByUserId(String SID, Long userId,
@@ -454,7 +458,7 @@ public class FileWebService {
* @param room_id
* the room id
* @param isOwner
- * @return
+ * @return - id of the folder
*/
public Long addFolderSelf(String SID, Long parentFileExplorerItemId,
String fileName, Long room_id, Boolean isOwner) throws AxisFault {
@@ -508,7 +512,7 @@ public class FileWebService {
* the od of the file or folder
* @param externalType
* the externalType
- * @return
+ * @return - null
*/
public Long deleteFileOrFolderByExternalIdAndType(String SID,
Long externalFilesid, String externalType) throws AxisFault {
@@ -539,7 +543,7 @@ public class FileWebService {
* The SID of the User. This SID must be marked as logged in
* @param fileExplorerItemId
* the id of the file or folder
- * @return
+ * @return - null
*/
public Long deleteFileOrFolder(String SID, Long fileExplorerItemId)
throws AxisFault {
@@ -569,7 +573,7 @@ public class FileWebService {
* The SID of the User. This SID must be marked as logged in
* @param fileExplorerItemId
* the id of the file or folder
- * @return
+ * @return - null
*/
public Long deleteFileOrFolderSelf(String SID, Long fileExplorerItemId)
throws AxisFault {
@@ -615,7 +619,8 @@ public class FileWebService {
*
* @param SID
* @param parentFolder
- * @return
+ *
+ * @return - LibraryPresentation-Object for a certain file
* @throws AxisFault
*/
public LibraryPresentation getPresentationPreviewFileExplorer(String SID,
@@ -661,7 +666,7 @@ public class FileWebService {
* Room id
* @param owner_id
* Owner id
- * @return
+ * @return - File Explorer Object by a given Room and owner id
* @throws AxisFault
*/
public FileExplorerObject getFileExplorerByRoom(String SID, Long room_id,
@@ -732,7 +737,7 @@ public class FileWebService {
* The SID of the User. This SID must be marked as logged in
* @param room_id
* Room Id
- * @return
+ * @return - File Explorer Object by a given Room
* @throws AxisFault
*/
public FileExplorerObject getFileExplorerByRoomSelf(String SID, Long room_id)
@@ -808,7 +813,7 @@ public class FileWebService {
* true if its a private drive
* @param owner_id
* the owner id
- * @return
+ * @return - FileExplorerItem list by parent folder
* @throws AxisFault
*/
public FileExplorerItem[] getFileExplorerByParent(String SID,
@@ -858,7 +863,7 @@ public class FileWebService {
* the room id
* @param isOwner
* true to request private drive
- * @return
+ * @return - list of file explorer items
* @throws AxisFault
*/
public FileExplorerItem[] getFileExplorerByParentSelf(String SID,
@@ -904,7 +909,7 @@ public class FileWebService {
* file or folder id
* @param fileName
* new file or folder name
- * @return
+ * @return - null
* @throws AxisFault
*/
public Long updateFileOrFolderName(String SID, Long fileExplorerItemId,
@@ -940,7 +945,7 @@ public class FileWebService {
* file or folder id
* @param fileName
* new file or folder name
- * @return
+ * @return - null
* @throws AxisFault
*/
public Long updateFileOrFolderNameSelf(String SID, Long fileExplorerItemId,
@@ -995,7 +1000,7 @@ public class FileWebService {
* if true move to private drive
* @param owner_id
* owner id
- * @return
+ * @return - null
* @throws AxisFault
*/
public Long moveFile(String SID, Long fileExplorerItemId,
@@ -1054,7 +1059,7 @@ public class FileWebService {
* if true owner id will be set
* @param moveToHome
* move to private drive
- * @return
+ * @return - null
* @throws AxisFault
*/
public Long moveFileSelf(String SID, Long fileExplorerItemId,
Modified: incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/axis/services/RoomWebService.java
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/axis/services/RoomWebService.java?rev=1417528&r1=1417527&r2=1417528&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/axis/services/RoomWebService.java (original)
+++ incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/axis/services/RoomWebService.java Wed Dec 5 17:06:00 2012
@@ -101,7 +101,7 @@ public class RoomWebService {
* @param SID
* The SID of the User. This SID must be marked as Loggedin
* @param roomtypes_id
- * @return Rooms[]
+ * @return - list of public rooms
* @throws AxisFault
*/
public Rooms[] getRoomsPublic(String SID, Long roomtypes_id)
@@ -147,7 +147,8 @@ public class RoomWebService {
* The SID of the User. This SID must be marked as Loggedin
* @param flvRecordingId
* the id of the recording
- * @return
+ *
+ * @return - true if recording was deleted
* @throws AxisFault
*/
public boolean deleteFlvRecording(String SID, Long flvRecordingId)
@@ -176,7 +177,8 @@ public class RoomWebService {
* The SID of the User. This SID must be marked as Loggedin
* @param externalUserId
* the externalUserId
- * @return
+ *
+ * @return - list of flv recordings
* @throws AxisFault
*/
public FLVRecordingReturn[] getFlvRecordingByExternalUserId(String SID,
@@ -227,7 +229,7 @@ public class RoomWebService {
* externalRoomType specified when creating the room
* @param insertedBy
* the userId that created the recording
- * @return
+ * @return - list of flv recordings
* @throws AxisFault
*/
public FLVRecordingReturn[] getFlvRecordingByExternalRoomTypeAndCreator(
@@ -278,7 +280,7 @@ public class RoomWebService {
* The SID of the User. This SID must be marked as Loggedin
* @param externalRoomType
* externalRoomType specified when creating the room
- * @return
+ * @return - list of flv recordings
* @throws AxisFault
*/
public List<FlvRecording> getFlvRecordingByExternalRoomTypeByList(
@@ -308,7 +310,7 @@ public class RoomWebService {
* The SID of the User. This SID must be marked as Loggedin
* @param externalRoomType
* externalRoomType specified when creating the room
- * @return
+ * @return - list of flv recordings
* @throws AxisFault
*/
public FlvRecording[] getFlvRecordingByExternalRoomType(String SID,
@@ -356,7 +358,7 @@ public class RoomWebService {
* The SID of the User. This SID must be marked as Loggedin
* @param roomId
* the room id
- * @return
+ * @return - list of recordings
* @throws AxisFault
*/
public FlvRecording[] getFlvRecordingByRoomId(String SID, Long roomId)
@@ -403,7 +405,7 @@ public class RoomWebService {
*
* @param SID
* The SID of the User. This SID must be marked as Loggedin
- * @return
+ * @return - List of available room types
* @throws AxisFault
*/
public RoomTypes[] getRoomTypes(String SID) throws AxisFault {
@@ -442,7 +444,7 @@ public class RoomWebService {
* @param roomId8
* @param roomId9
* @param roomId10
- * @return
+ * @return - current users for rooms ids
* @throws AxisFault
*/
public RoomCountBean[] getRoomCounters(String SID, Integer roomId1,
@@ -524,7 +526,7 @@ public class RoomWebService {
* The SID of the User. This SID must be marked as Loggedin
* @param rooms_id
* the room id
- * @return
+ * @return - room with the id given
*/
public Rooms getRoomById(String SID, long rooms_id) {
return conferenceService.getRoomById(SID, rooms_id);
@@ -535,7 +537,7 @@ public class RoomWebService {
* @param SID
* The SID of the User. This SID must be marked as Loggedin
* @param rooms_id
- * @return
+ * @return - room with the id given
*/
@Deprecated
public Rooms getRoomWithCurrentUsersById(String SID, long rooms_id) {
@@ -548,7 +550,7 @@ public class RoomWebService {
* @param SID
* The SID of the User. This SID must be marked as Loggedin
* @param rooms_id
- * @return
+ * @return - object of type RoomReturn
* @throws AxisFault
*/
public RoomReturn getRoomWithClientObjectsById(String SID, long rooms_id)
@@ -614,7 +616,8 @@ public class RoomWebService {
* The column it will be ordered
* @param asc
* Asc or Desc sort ordering
- * @return
+ *
+ * @return - List of Objects of Rooms
*/
public SearchResult<Rooms> getRooms(String SID, int start, int max,
String orderby, boolean asc) {
@@ -636,7 +639,8 @@ public class RoomWebService {
* The column it will be ordered
* @param asc
* Asc or Desc sort ordering
- * @return
+ *
+ * @return - List of Objects of Rooms
*/
public SearchResult<Rooms> getRoomsWithCurrentUsers(String SID, int start,
int max, String orderby, boolean asc) {
@@ -673,7 +677,7 @@ public class RoomWebService {
* @param filesPanelYPosition
* @param filesPanelHeight
* @param filesPanelWidth
- * @return
+ * @return - id of the room or error code
*/
@Deprecated
public Long addRoom(String SID, String name, Long roomtypes_id,
@@ -742,7 +746,8 @@ public class RoomWebService {
* Users have to wait untill a Moderator arrives. Use the
* becomeModerator param in setUserObjectAndGenerateRoomHash to
* set a user as default Moderator
- * @return
+ *
+ * @return - id of the room or error code
*/
public Long addRoomWithModeration(String SID, String name,
Long roomtypes_id, String comment, Long numberOfPartizipants,
@@ -809,7 +814,8 @@ public class RoomWebService {
* @param allowUserQuestions
* enable or disable the button to allow users to apply for
* moderation
- * @return
+ *
+ * @return - id of the room or error code
*/
public Long addRoomWithModerationAndQuestions(String SID, String name,
Long roomtypes_id, String comment, Long numberOfPartizipants,
@@ -879,7 +885,8 @@ public class RoomWebService {
* moderation
* @param isAudioOnly
* enable or disable the video / or audio-only
- * @return
+ *
+ * @return - id of the room or error code
* @throws AxisFault
*/
public Long addRoomWithModerationQuestionsAndAudioType(String SID,
@@ -967,7 +974,8 @@ public class RoomWebService {
* @param hideWhiteboard
* hide or show Whiteboard. If whitboard is hidden, video pods
* and scrollbar appear instead.
- * @return
+ *
+ * @return - id of the room or error code
* @throws AxisFault
*/
public Long addRoomWithModerationQuestionsAudioTypeAndHideOptions(
@@ -1042,7 +1050,8 @@ public class RoomWebService {
* @param externalRoomType
* you can specify your system-name or type of room here, for
* example "moodle"
- * @return
+ *
+ * @return - id of the room or error code
* @throws AxisFault
*/
public Long getRoomIdByExternalId(String SID, String name,
@@ -1103,7 +1112,8 @@ public class RoomWebService {
* @param filesPanelYPosition
* @param filesPanelHeight
* @param filesPanelWidth
- * @return
+ *
+ * @return - id of the room updated or error code
*/
@Deprecated
public Long updateRoom(String SID, Long rooms_id, String name,
@@ -1174,7 +1184,8 @@ public class RoomWebService {
* Users have to wait until a Moderator arrives. Use the
* becomeModerator parameter in setUserObjectAndGenerateRoomHash
* to set a user as default Moderator
- * @return
+ *
+ * @return - id of the room updated or error code
*/
public Long updateRoomWithModeration(String SID, Long room_id, String name,
Long roomtypes_id, String comment, Long numberOfPartizipants,
@@ -1240,7 +1251,8 @@ public class RoomWebService {
* @param allowUserQuestions
* enable or disable the button to allow users to apply for
* moderation
- * @return
+ *
+ * @return - id of the room updated or error code
*/
public Long updateRoomWithModerationAndQuestions(String SID, Long room_id,
String name, Long roomtypes_id, String comment,
@@ -1326,7 +1338,8 @@ public class RoomWebService {
* @param hideWhiteboard
* hide or show Whiteboard. If whitboard is hidden, video pods
* and scrollbar appear instead.
- * @return
+ *
+ * @return - id of the room updated or error code
*/
public Long updateRoomWithModerationQuestionsAudioTypeAndHideOptions(
String SID, Long room_id, String name, Long roomtypes_id,
@@ -1367,7 +1380,8 @@ public class RoomWebService {
* @param SID
* The SID of the User. This SID must be marked as Loggedin
* @param rooms_id
- * @return
+ *
+ * @return - id of the room deleted
*/
public Long deleteRoom(String SID, long rooms_id) {
return conferenceService.deleteRoom(SID, rooms_id);
@@ -1381,7 +1395,8 @@ public class RoomWebService {
* _Admin
* @param room_id
* the room id
- * @return
+ *
+ * @return - true if user was kicked, false otherwise
*/
public Boolean kickUser(String SID_Admin, Long room_id) {
try {
@@ -1432,7 +1447,8 @@ public class RoomWebService {
* @param externalRoomType
* the external room type (can be used to identify different
* external systems using same OpenMeetings instance)
- * @return
+ *
+ * @return - id of the room added or error code
*/
public Long addRoomWithModerationAndExternalType(String SID, String name,
Long roomtypes_id, String comment, Long numberOfPartizipants,
@@ -1490,7 +1506,8 @@ public class RoomWebService {
* moderation
* @param isAudioOnly
* enable or disable the video / or audio-only
- * @return
+ *
+ * @return - id of the room added or error code
*/
public Long addRoomWithModerationExternalTypeAndAudioType(String SID,
String name, Long roomtypes_id, String comment,
@@ -1555,7 +1572,8 @@ public class RoomWebService {
* should start recording before they do a conference
* @param allowRecording
* if the recording option is available or not
- * @return
+ *
+ * @return - id of the room added or error code
*/
public Long addRoomWithModerationAndRecordingFlags(String SID, String name,
Long roomtypes_id, String comment, Long numberOfPartizipants,
@@ -1626,7 +1644,8 @@ public class RoomWebService {
* if the recording option is available or not
* @param hideTopBar
* if the top bar in the conference room is visible or not
- * @return
+ *
+ * @return - id of the room added or error code
*/
public Long addRoomWithModerationExternalTypeAndTopBarOption(String SID,
String name, Long roomtypes_id, String comment,
@@ -2024,7 +2043,8 @@ public class RoomWebService {
* The column it will be ordered
* @param asc
* Asc or Desc sort ordering
- * @return
+ *
+ * @return - RoomReturn Objects with information of the current users
* @throws AxisFault
*/
public List<RoomReturn> getRoomsWithCurrentUsersByList(String SID,
@@ -2089,7 +2109,8 @@ public class RoomWebService {
* Asc or Desc sort ordering
* @param externalRoomType
* the external room type
- * @return
+ *
+ * @return - list of room return objects
* @throws AxisFault
*/
public List<RoomReturn> getRoomsWithCurrentUsersByListAndType(String SID,
@@ -2187,7 +2208,8 @@ public class RoomWebService {
* 1=none, 2=simple mail, 3=ICAL
* @param redirectURL
* URL Users will be lead to if the Conference Time is elapsed
- * @return
+ *
+ * @return - id of the room in case of success, error code otherwise
* @throws AxisFault
*/
public Long addRoomWithModerationAndExternalTypeAndStartEnd(String SID,
@@ -2305,7 +2327,8 @@ public class RoomWebService {
* @param language_id
* The ID of the language, for the email that is send to the
* meeting member
- * @return
+ *
+ * @return - id of the member in case of success, error code otherwise
* @throws AxisFault
*/
public Long addMeetingMemberRemindToRoom(String SID, Long room_id,
@@ -2366,7 +2389,8 @@ public class RoomWebService {
* name of the timezone
* @param invitorName
* name of invitation creators
- * @return
+ *
+ * @return - id of the member in case of success, error code otherwise
* @throws AxisFault
*/
public Long addExternalMeetingMemberRemindToRoom(String SID, Long room_id,
@@ -2418,7 +2442,8 @@ public class RoomWebService {
* the room id
* @param status
* false = close, true = open
- * @return
+ *
+ * @return - 1 in case of success, -2 otherwise
* @throws AxisFault
*/
public int closeRoom(String SID, Long room_id, Boolean status)
Modified: incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/axis/services/UserWebService.java
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/axis/services/UserWebService.java?rev=1417528&r1=1417527&r2=1417528&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/axis/services/UserWebService.java (original)
+++ incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/axis/services/UserWebService.java Wed Dec 5 17:06:00 2012
@@ -86,7 +86,7 @@ public class UserWebService {
* load this session id before doing anything else Returns an Object of Type
* Sessiondata, this contains a sessionId, use that sessionId in all Methods
*
- * @return
+ * @return - creates new session
*/
public Sessiondata getSession() {
log.debug("SPRING LOADED getSession -- ");
@@ -104,7 +104,8 @@ public class UserWebService {
* Username from OpenMeetings, the user has to have Admin-rights
* @param userpass
* Userpass from OpenMeetings
- * @return
+ *
+ * @return - id of the logged in user, -1 in case of the error
*/
public Long loginUser(String SID, String username, String userpass)
throws AxisFault {
@@ -138,7 +139,8 @@ public class UserWebService {
* the error id (negative Value here!)
* @param language_id
* The id of the language
- * @return
+ *
+ * @return - error with the code given
*/
public ErrorResult getErrorByCode(String SID, long errorid, long language_id) {
try {
@@ -202,7 +204,8 @@ public class UserWebService {
* the baseURL is needed to send the Initial Email correctly to
* that User, otherwise the Link in the EMail that the new User
* will reveive is not valid
- * @return
+ *
+ * @return - id of the user added or error code
* @throws AxisFault
*/
public Long addNewUser(String SID, String username, String userpass,
@@ -289,7 +292,8 @@ public class UserWebService {
* will reveive is not valid
* @param jNameTimeZone
* the name of the timezone for the user
- * @return
+ *
+ * @return - id of the user added or the error code
* @throws AxisFault
*/
public Long addNewUserWithTimeZone(String SID, String username,
@@ -379,7 +383,8 @@ public class UserWebService {
* externalUserId
* @param externalUserType
* externalUserType
- * @return
+ *
+ * @return - id of user added or error code
* @throws AxisFault
*/
public Long addNewUserWithExternalType(String SID, String username,
@@ -442,7 +447,8 @@ public class UserWebService {
* The SID from getSession
* @param userId
* the openmeetings user id
- * @return
+ *
+ * @return - id of the user deleted, error code otherwise
* @throws AxisFault
*/
public Long deleteUserById(String SID, Long userId) throws AxisFault {
@@ -477,7 +483,8 @@ public class UserWebService {
* externalUserId
* @param externalUserType
* externalUserId
- * @return
+ *
+ * @return - id of user deleted, or error code
* @throws AxisFault
*/
public Long deleteUserByExternalUserIdAndType(String SID,
@@ -526,7 +533,8 @@ public class UserWebService {
* any profilePictureUrl
* @param email
* any email
- * @return
+ *
+ * @return - 1 in case of success, -1 otherwise
* @throws AxisFault
*/
@Deprecated
@@ -591,7 +599,8 @@ public class UserWebService {
* if you have any external user Id you may set it here
* @param externalUserType
* you can specify your system-name here, for example "moodle"
- * @return
+ *
+ * @return - 1 in case of success, -1 otherwise
* @throws AxisFault
*/
@Deprecated
@@ -665,7 +674,8 @@ public class UserWebService {
* @param showAudioVideoTestAsInt
* 0 means don't show Audio/Video Test, 1 means show Audio/Video
* Test Application before the user is logged into the room
- * @return
+ *
+ * @return - secure hash or error code
* @throws AxisFault
*/
public String setUserObjectAndGenerateRoomHash(String SID, String username,
@@ -764,7 +774,8 @@ public class UserWebService {
* @param showAudioVideoTestAsInt
* 0 means don't show Audio/Video Test, 1 means show Audio/Video
* Test Application before the user is logged into the room
- * @return
+ *
+ * @return - secure hash or error code
*/
public String setUserObjectAndGenerateRoomHashByURL(String SID,
String username, String firstname, String lastname,
@@ -867,7 +878,8 @@ public class UserWebService {
* Test Application before the user is logged into the room
* @param allowRecording
* 0 means don't allow Recording, 1 means allow Recording
- * @return
+ *
+ * @return - secure hash or error code
*/
public String setUserObjectAndGenerateRoomHashByURLAndRecFlag(String SID,
String username, String firstname, String lastname,
@@ -963,7 +975,8 @@ public class UserWebService {
* if you have any external user Id you may set it here
* @param externalUserType
* you can specify your system-name here, for example "moodle"
- * @return
+ *
+ * @return - secure hash or error code
*/
public String setUserObjectMainLandingZone(String SID, String username,
String firstname, String lastname, String profilePictureUrl,
@@ -1062,7 +1075,8 @@ public class UserWebService {
* @param showNickNameDialogAsInt
* 0 means do not show the popup to enter a nichname, 1 means
* that there is a popup to enter the nickname for the conference
- * @return
+ *
+ * @return - secure hash, or error code
*/
public String setUserAndNickName(String SID, String username,
String firstname, String lastname, String profilePictureUrl,
@@ -1148,7 +1162,8 @@ public class UserWebService {
* @param recording_id
* the id of the recording, get a List of all Recordings with
* RoomService::getFlvRecordingByExternalRoomType
- * @return
+ *
+ * @return - hash of the recording, or error id
*/
public String setUserObjectAndGenerateRecordingHashByURL(String SID,
String username, String firstname, String lastname,
@@ -1212,7 +1227,7 @@ public class UserWebService {
* the organization id
* @param insertedby
* user id of the operating user
- * @return
+ * @return - id of the user added, or error id in case of the error
*/
public Long addUserToOrganisation(String SID, Long user_id,
Long organisation_id, Long insertedby) {
@@ -1248,7 +1263,7 @@ public class UserWebService {
* orderby clause
* @param asc
* asc or desc
- * @return
+ * @return - users found
*/
public SearchResult<Users> getUsersByOrganisation(String SID,
long organisation_id, int start, int max, String orderby,
@@ -1280,7 +1295,7 @@ public class UserWebService {
* @param publicSID
* the publicSID (you can get it from the call to get users in a
* room)
- * @return
+ * @return - <code>true</code> if user was kicked
*/
public Boolean kickUserByPublicSID(String SID, String publicSID) {
try {
Modified: incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/CalendarService.java
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/CalendarService.java?rev=1417528&r1=1417527&r2=1417528&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/CalendarService.java (original)
+++ incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/CalendarService.java Wed Dec 5 17:06:00 2012
@@ -377,7 +377,7 @@ public class CalendarService {
/**
*
* @param SID
- * @return
+ * @return - the list of appointment reminder types in case of success, null otherwise
*/
public List<AppointmentReminderTyps> getAppointmentReminderTypList(
String SID) {
Modified: incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/ChatService.java
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/ChatService.java?rev=1417528&r1=1417527&r2=1417528&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/ChatService.java (original)
+++ incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/ChatService.java Wed Dec 5 17:06:00 2012
@@ -91,8 +91,9 @@ public class ChatService implements IPen
* sends a Chat-Message
* to all members of the Chatroom
* and all additional users (waitng for a free entry for example)
+ *
* @param newMessage
- * @return
+ * @return - 1 in case of success, -1 otherwise
*/
@SuppressWarnings("unchecked")
public int sendMessageWithClient(Object newMessage) {
@@ -313,9 +314,9 @@ public class ChatService implements IPen
/**
* gets the chat history by string for non-conference-clients
- * @param roomname
- * @param orgdomain
- * @return
+ *
+ * @param room_id
+ * @return - chat history of the room given, null in case of exception
*/
public List<HashMap<String,Object>> getRoomChatHistoryByString(Long room_id) {
try {
@@ -340,9 +341,9 @@ public class ChatService implements IPen
/**
* sends a message to all connected users
- * @param SID
+ *
* @param newMessage
- * @return
+ * @return - 1 in case of success, -1 otherwise
*/
@SuppressWarnings({ "rawtypes", "unchecked" })
public int sendMessageToOverallChat(Object newMessage) {
@@ -389,9 +390,8 @@ public class ChatService implements IPen
/**
* gets the chat history of overallChat
- * @param roomname
- * @param orgdomain
- * @return
+ *
+ * @return - overall chat history
*/
public List<HashMap<String,Object>> getOverallChatHistory() {
try {
@@ -408,7 +408,7 @@ public class ChatService implements IPen
/**
* clear the overallChat history
- * @return
+ * @return - all messages being cleaned, null in case of error
*/
public List<HashMap<String,Object>> clearOverallChat() {
try {
Modified: incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/ConferenceLibrary.java
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/ConferenceLibrary.java?rev=1417528&r1=1417527&r2=1417528&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/ConferenceLibrary.java (original)
+++ incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/ConferenceLibrary.java Wed Dec 5 17:06:00 2012
@@ -118,7 +118,7 @@ public class ConferenceLibrary implement
* @param room_id
* @param fileName
* @param tObjectRef
- * @return
+ * @return - file-explorer Id in case of success, -1 otherwise
*/
public Long saveAsObject(String SID, Long room_id, String fileName,
Object tObjectRef) {
@@ -261,7 +261,7 @@ public class ConferenceLibrary implement
* @param SID
* @param room_id
* @param fileName
- * @return
+ * @return - chart object
*/
@SuppressWarnings("rawtypes")
public ArrayList loadChartObject(String SID, Long room_id, String fileName) {
@@ -279,162 +279,10 @@ public class ConferenceLibrary implement
}
/**
- *
- * Load all objects of a conference room
- *
* @param SID
- * @param room_id
- * @return
- *
- * public FileExplorerObject getFileExplorerByRoom(String SID, Long
- * room_id) { try { Long users_id =
- * Sessionmanagement.getInstance().checkSession(SID); Long
- * user_level = userManagement.getUserLevelByID( users_id); if
- * (authLevelManagement.checkUserLevel(user_level)) {
- *
- * log.debug("room_id " + room_id);
- *
- * FileExplorerObject fileExplorerObject = new FileExplorerObject();
- *
- * // Home File List FileExplorerItem[] fList =
- * FileExplorerItemDaoImpl .getInstance()
- * .getFileExplorerItemsByOwner(users_id, 0L);
- *
- * long homeFileSize = 0;
- *
- * for (FileExplorerItem homeChildExplorerItem : fList) {
- * log.debug("FileExplorerItem fList " +
- * homeChildExplorerItem.getFileName()); homeFileSize +=
- * FileUtils.getInstance()
- * .getSizeOfDirectoryAndSubs(homeChildExplorerItem); }
- *
- * fileExplorerObject.setUserHome(fList);
- * fileExplorerObject.setUserHomeSize(homeFileSize);
- *
- * // Public File List FileExplorerItem[] rList =
- * FileExplorerItemDaoImpl
- * .getInstance().getFileExplorerItemsByRoom(room_id, 0L);
- *
- * long roomFileSize = 0;
- *
- * for (FileExplorerItem homeChildExplorerItem : rList) {
- * log.debug("FileExplorerItem rList " +
- * homeChildExplorerItem.getFileName()); roomFileSize +=
- * FileUtils.getInstance()
- * .getSizeOfDirectoryAndSubs(homeChildExplorerItem); }
- *
- * fileExplorerObject.setRoomHome(rList);
- * fileExplorerObject.setRoomHomeSize(roomFileSize);
- *
- * return fileExplorerObject;
- *
- * } } catch (Exception err) { log.error("[getFileExplorerByRoom] ",
- * err); } return null; }
- *
- * public FileExplorerItem[] getFileExplorerByParent(String SID,
- * Long parentFileExplorerItemId, Long room_id, Boolean isOwner) {
- * try { Long users_id =
- * Sessionmanagement.getInstance().checkSession(SID); Long
- * user_level = userManagement.getUserLevelByID( users_id); if
- * (authLevelManagement.checkUserLevel(user_level)) {
- *
- * log.debug("parentFileExplorerItemId " +
- * parentFileExplorerItemId);
- *
- * if (parentFileExplorerItemId == 0) { if (isOwner) { return
- * FileExplorerItemDaoImpl.getInstance()
- * .getFileExplorerItemsByOwner(users_id, parentFileExplorerItemId);
- * } else { return FileExplorerItemDaoImpl.getInstance()
- * .getFileExplorerItemsByRoom(room_id, parentFileExplorerItemId); }
- * } else { return FileExplorerItemDaoImpl.getInstance()
- * .getFileExplorerItemsByParent( parentFileExplorerItemId); }
- *
- * } } catch (Exception err) {
- * log.error("[getFileExplorerByParent] ", err); } return null; }
- *
- * public Long addFolder(String SID, Long parentFileExplorerItemId,
- * String fileName, Long room_id, Boolean isOwner) { try { Long
- * users_id = Sessionmanagement.getInstance().checkSession(SID);
- * Long user_level = userManagement.getUserLevelByID( users_id); if
- * (authLevelManagement.checkUserLevel(user_level)) {
- *
- * log.debug("addFolder " + parentFileExplorerItemId);
- *
- * if (parentFileExplorerItemId == 0 && isOwner) { // users_id
- * (OwnerID) => only set if its directly root in // Owner Directory,
- * // other Folders and Files maybe are also in a Home // directory
- * // but just because their parent is return
- * FileExplorerItemDaoImpl.getInstance().add(fileName, "",
- * parentFileExplorerItemId, users_id, room_id, users_id, true, //
- * isFolder false, // isImage false, // isPresentation "", // WML
- * Path false, // isStoredWML file false // isXmlFile , 0L, ""); }
- * else { return FileExplorerItemDaoImpl.getInstance().add(fileName,
- * "", parentFileExplorerItemId, null, room_id, users_id, true, //
- * isFolder false, // isImage false, // isPresentation "", // WML
- * Paht false, // isStoredWML file false // isXmlFile , 0L, ""); } }
- * } catch (Exception err) { log.error("[getFileExplorerByParent] ",
- * err); } return null; }
- *
- * public Long deleteFileOrFolder(String SID, Long
- * fileExplorerItemId) { try { Long users_id =
- * Sessionmanagement.getInstance().checkSession(SID); Long
- * user_level = userManagement.getUserLevelByID( users_id); if
- * (authLevelManagement.checkUserLevel(user_level)) {
- *
- * log.debug("deleteFileOrFolder " + fileExplorerItemId);
- *
- * FileExplorerItemDaoImpl.getInstance().deleteFileExplorerItem(
- * fileExplorerItemId);
- *
- * } } catch (Exception err) {
- * log.error("[getFileExplorerByParent] ", err); } return null; }
- *
- * public Long updateFileOrFolderName(String SID, Long
- * fileExplorerItemId, String fileName) { try { Long users_id =
- * Sessionmanagement.getInstance().checkSession(SID); Long
- * user_level = userManagement.getUserLevelByID( users_id); if
- * (authLevelManagement.checkUserLevel(user_level)) {
- *
- * log.debug("deleteFileOrFolder " + fileExplorerItemId);
- *
- * FileExplorerItemDaoImpl.getInstance().updateFileOrFolderName(
- * fileExplorerItemId, fileName);
- *
- * } } catch (Exception err) {
- * log.error("[updateFileOrFolderName] ", err); } return null; }
- *
- * public Long moveFile(String SID, Long fileExplorerItemId, Long
- * newParentFileExplorerItemId, Long room_id, Boolean isOwner,
- * Boolean moveToHome) { try { Long users_id =
- * Sessionmanagement.getInstance().checkSession(SID); Long
- * user_level = userManagement.getUserLevelByID( users_id); if
- * (authLevelManagement.checkUserLevel(user_level)) {
- *
- * log.debug("deleteFileOrFolder " + fileExplorerItemId);
- *
- * FileExplorerItemDaoImpl.getInstance().moveFile(
- * fileExplorerItemId, newParentFileExplorerItemId, room_id,
- * isOwner, users_id);
- *
- * FileExplorerItem fileExplorerItem = FileExplorerItemDaoImpl
- * .getInstance().getFileExplorerItemsById( fileExplorerItemId);
- *
- * if (moveToHome) { // set this file and all subfiles and folders
- * the ownerId
- * FileUtils.getInstance().setFileToOwnerOrRoomByParent(fileExplorerItem
- * , users_id, null);
- *
- * } else { // set this file and all subfiles and folders the
- * room_id
- * FileUtils.getInstance().setFileToOwnerOrRoomByParent(fileExplorerItem
- * , null, room_id);
- *
- * }
- *
- * } } catch (Exception err) {
- * log.error("[updateFileOrFolderName] ", err); } return null; }
+ * @param flvFileExplorerId
+ * @return 1 in case of success, -1 otherwise
*/
-
public Long copyFileToCurrentRoom(String SID, Long flvFileExplorerId) {
try {
Modified: incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/ConferenceService.java
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/ConferenceService.java?rev=1417528&r1=1417527&r2=1417528&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/ConferenceService.java (original)
+++ incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/ConferenceService.java Wed Dec 5 17:06:00 2012
@@ -87,12 +87,12 @@ public class ConferenceService {
private ServerDao serverDao;
/**
- * ( get a List of all availible Rooms of this organisation
+ * ( get a List of all available Rooms of this organization
* (non-appointments)
*
* @param SID
* @param organisation_id
- * @return
+ * @return - all available Rooms of this organization
*/
public List<Rooms_Organisation> getRoomsByOrganisationAndType(String SID,
long organisation_id, long roomtypes_id) {
@@ -161,7 +161,7 @@ public class ConferenceService {
*
* @param SID
* @param organisation_id
- * @return
+ * @return - all rooms of an organization
*/
public SearchResult<Rooms_Organisation> getRoomsByOrganisation(String SID,
long organisation_id, int start, int max, String orderby,
@@ -181,8 +181,8 @@ public class ConferenceService {
* get a List of all public availible rooms (non-appointments)
*
* @param SID
- * @param organisation_id
- * @return
+ * @param roomtypes_id
+ * @return - public rooms with given type, null in case of the error
*/
public List<Rooms> getRoomsPublic(String SID, Long roomtypes_id) {
try {
@@ -238,7 +238,7 @@ public class ConferenceService {
/**
* retrieving ServerTime
*
- * @return
+ * @return - server time
*/
// --------------------------------------------------------------------------------------------
public Date getServerTime() {
@@ -254,10 +254,9 @@ public class ConferenceService {
*
* retrieving Appointment for Room
*
- * @author o.becherer
- *
+ * @param room_id
+ * @return - Appointment in case the room is appointment, null otherwise
*/
- // --------------------------------------------------------------------------------------------
public Appointment getAppointMentDataForRoom(Long room_id) {
log.debug("getAppointMentDataForRoom");
@@ -407,7 +406,7 @@ public class ConferenceService {
/**
*
* @param SID
- * @return
+ * @return - all room types available
*/
public List<RoomTypes> getRoomTypes(String SID) {
Long users_id = sessionManagement.checkSession(SID);
@@ -422,7 +421,7 @@ public class ConferenceService {
*
* @param SID
* @param rooms_id
- * @return
+ * @return - room with the id given
*/
public Rooms getRoomById(String SID, long rooms_id) {
Long users_id = sessionManagement.checkSession(SID);
@@ -441,8 +440,10 @@ public class ConferenceService {
/**
*
* @param SID
- * @param rooms_id
- * @return
+ * @param externalUserId
+ * @param externalUserType
+ * @param roomtypes_id
+ * @return - room with the given external id
*/
public Rooms getRoomByExternalId(String SID, Long externalUserId,
String externalUserType, long roomtypes_id) {
@@ -453,14 +454,14 @@ public class ConferenceService {
}
/**
- * gets a list of all availible rooms
+ * gets a list of all available rooms
*
* @param SID
* @param start
* @param max
* @param orderby
* @param asc
- * @return
+ * @return - list of rooms being searched
*/
public SearchResult<Rooms> getRooms(String SID, int start, int max,
String orderby, boolean asc, String search) {
@@ -487,7 +488,7 @@ public class ConferenceService {
*
* @param SID
* @param rooms_id
- * @return
+ * @return - all Organisations of a room
*/
public List<Rooms_Organisation> getOrganisationByRoom(String SID,
long rooms_id) {
@@ -500,7 +501,7 @@ public class ConferenceService {
*
* @param SID
* @param argObject
- * @return
+ * @return - id of the room being saved, null in case of the error
*/
public Long saveOrUpdateRoom(String SID, Object argObject) {
try {
@@ -665,7 +666,7 @@ public class ConferenceService {
*
* @param SID
* @param rooms_id
- * @return
+ * @return - id of the room being deleted
*/
public Long deleteRoom(String SID, long rooms_id) {
Long users_id = sessionManagement.checkSession(SID);
@@ -677,7 +678,7 @@ public class ConferenceService {
* return all participants of a room
*
* @param room_id
- * @return
+ * @return - true if room is full, false otherwise
*/
public boolean isRoomFull(Long room_id) {
try {
@@ -699,7 +700,7 @@ public class ConferenceService {
* return all participants of a room
*
* @param room_id
- * @return
+ * @return - all participants of a room
*/
public List<RoomClient> getRoomClientsListByRoomId(Long room_id) {
return clientListManager.getClientListByRoom(room_id, null);
@@ -713,7 +714,7 @@ public class ConferenceService {
* @param max
* @param orderby
* @param asc
- * @return
+ * @return - list of the connections currently open
*/
public SearchResult<ClientSession> getRoomClientsMap(String SID, int start, int max,
String orderby, boolean asc) {
Modified: incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/ConfigurationService.java
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/ConfigurationService.java?rev=1417528&r1=1417527&r2=1417528&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/ConfigurationService.java (original)
+++ incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/ConfigurationService.java Wed Dec 5 17:06:00 2012
@@ -71,7 +71,7 @@ public class ConfigurationService {
*
* @param SID
* @param configuration_id
- * @return
+ * @return - configuration with the id given, null otherwise
*/
public Configuration getConfByConfigurationId(String SID,long configuration_id){
Long users_id = sessionManagement.checkSession(SID);
@@ -90,7 +90,7 @@ public class ConfigurationService {
*
* @param SID
* @param values
- * @return
+ * @return - id of configuration being updated, null otherwise
*/
public Long saveOrUpdateConfiguration(String SID, LinkedHashMap<String, ?> values){
Long users_id = sessionManagement.checkSession(SID);
@@ -110,7 +110,7 @@ public class ConfigurationService {
*
* @param SID
* @param values
- * @return
+ * @return - id of configuration being deleted in case of success, null otherwise
*/
public Long deleteConfiguration(String SID, LinkedHashMap<String, ?> values){
Long users_id = sessionManagement.checkSession(SID);
Modified: incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/ErrorService.java
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/ErrorService.java?rev=1417528&r1=1417527&r2=1417528&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/ErrorService.java (original)
+++ incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/ErrorService.java Wed Dec 5 17:06:00 2012
@@ -49,7 +49,7 @@ public class ErrorService {
*
* @param SID
* @param errorid
- * @return
+ * @return - ErrorResult object with the id given
*/
public ErrorResult getErrorByCode(String SID, Long errorid, Long language_id) {
// Long users_id = Sessionmanagement.getInstance().checkSession(SID);
Modified: incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/InvitationService.java
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/InvitationService.java?rev=1417528&r1=1417527&r2=1417528&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/InvitationService.java (original)
+++ incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/InvitationService.java Wed Dec 5 17:06:00 2012
@@ -80,7 +80,7 @@ public class InvitationService implement
* @param validToTime
* @param language_id
* @param jNameTimeZone
- * @return
+ * @return - invitation object in case of success, "Sys - Error" string or null in case of error
*/
public Object sendInvitationHash(String SID, String username,
String message, String baseurl, String email, String subject,
Modified: incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/LanguageService.java
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/LanguageService.java?rev=1417528&r1=1417527&r2=1417528&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/LanguageService.java (original)
+++ incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/LanguageService.java Wed Dec 5 17:06:00 2012
@@ -60,9 +60,9 @@ public class LanguageService {
private AuthLevelmanagement authLevelManagement;
/**
- * get a List of all availible Languages
+ * get a List of all availaible Languages
*
- * @return
+ * @return - List of all availaible Languages
*/
public List<FieldLanguage> getLanguages() {
return fieldLanguageDaoImpl.getLanguages();
@@ -73,7 +73,7 @@ public class LanguageService {
*
* @param language_id
* @deprecated
- * @return
+ * @return - all fields of a given Language_id
*/
@Deprecated
public List<Fieldlanguagesvalues> getLanguageById(Long language_id) {
@@ -91,7 +91,7 @@ public class LanguageService {
* get all fields of a given Language_id by params
*
* @param language_id
- * @return
+ * @return - all fields of a given Language_id in the range given
*/
public List<Map<String, Object>> getLanguageByIdAndMax(Long language_id,
int start, int max) {
@@ -162,7 +162,7 @@ public class LanguageService {
* @param orderby
* @param asc
* @param language_id
- * @return
+ * @return - the list of field values being searched in case of success, null otherwise
*/
public SearchResult<Fieldvalues> getFieldsByLanguage(String SID, int start, int max,
String orderby, boolean asc, Long language_id, String search) {
@@ -179,7 +179,7 @@ public class LanguageService {
*
* @param SID
* @param values
- * @return
+ * @return - id of the label added or updated in case of success, error code otherwise
*/
public Long saveOrUpdateLabel(String SID,
LinkedHashMap<Object, Object> values) {
Modified: incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/LdapConfigService.java
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/LdapConfigService.java?rev=1417528&r1=1417527&r2=1417528&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/LdapConfigService.java (original)
+++ incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/LdapConfigService.java Wed Dec 5 17:06:00 2012
@@ -102,8 +102,7 @@ public class LdapConfigService {
* @param max
* @param orderby
* @param asc
- * @param language_id
- * @return
+ * @return - the list of lgap config object being searched
*/
public SearchResult<LdapConfig> getLdapConfigs(String SID, int start, int max, String orderby, boolean asc){
Long users_id = sessionManagement.checkSession(SID);
@@ -124,7 +123,7 @@ public class LdapConfigService {
*
* @param SID
* @param values
- * @return
+ * @return - id of added or updated config in case of success, error code otherwise
*/
public Long saveOrUpdateLdapConfig(String SID, LinkedHashMap<Object,Object> values) {
try {
Modified: incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/MainService.java
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/MainService.java?rev=1417528&r1=1417527&r2=1417528&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/MainService.java (original)
+++ incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/MainService.java Wed Dec 5 17:06:00 2012
@@ -123,7 +123,7 @@ public class MainService implements IPen
*
* @param SID
* @param language_id
- * @return
+ * @return - list of global navigation menus
*/
public List<Naviglobal> getNavi(String SID, long language_id, Long organisation_id) {
try {
@@ -144,7 +144,7 @@ public class MainService implements IPen
*
* @param SID
* @param USER_ID
- * @return
+ * @return - user with SID given
*/
public Users getUser(String SID, int USER_ID) {
Users users = new Users();
@@ -176,11 +176,11 @@ public class MainService implements IPen
}
/**
- * This Method is jsut for testing you can find the corresponding CLietn
+ * This Method is just for testing you can find the corresponding Client
* Function in xmlcrm/auth/checkLoginData.lzx
*
* @param myObject2
- * @return
+ * @return - the size of the map passed, or -1 in case of error
*/
public int testObject(Object myObject2) {
try {
@@ -283,8 +283,11 @@ public class MainService implements IPen
* auth function, use the SID you get by getsessiondata
*
* @param SID
- * @param Username
+ * @param usernameOrEmail
* @param Userpass
+ * @param storePermanent
+ * @param language_id
+ * @param ldapConfigId
* @return a valid user account or an empty user with an error message and
* level -1
*/
@@ -512,9 +515,11 @@ public class MainService implements IPen
* param showNickNameDialog in the Object SOAPLogin to true the user gets
* displayed an additional dialog to enter his nickname
*
- * @return
+ * @param firstname
+ * @param lastname
+ * @param email
+ * @return - 1 in case of success, -1 otherwise
*/
-
public Long setUserNickName(String firstname, String lastname, String email) {
try {
@@ -552,7 +557,7 @@ public class MainService implements IPen
* retrieved in the call from the SOAP Gateway!
*
* @param SID
- * @return
+ * @return - 1 in case of success, -1 otherwise
*/
public Long loginUserByRemote(String SID) {
try {
@@ -735,7 +740,7 @@ public class MainService implements IPen
* in, needs no authentification to load
*
* @param SID
- * @return
+ * @return configuration with key "allow_frontend_register"
*/
public Configuration allowFrontendRegister(String SID) {
return configurationDaoImpl.getConfKey("allow_frontend_register");
@@ -787,7 +792,7 @@ public class MainService implements IPen
* Object To allow the registering the config_key *allow_frontend_register*
* has to be the value 1 otherwise the user will get an error code
*
- * @param regObject
+ * @param regObjectObj
* @return new users_id OR null if an exception, -1 if an error, -4 if mail
* already taken, -5 if username already taken, -3 if login or pass
* or mail is empty
@@ -866,7 +871,7 @@ public class MainService implements IPen
* logs a user out and deletes his account
*
* @param SID
- * @return
+ * @return - id of user being deleted, or error code
*/
public Long deleteUserIDSelf(String SID) {
Long users_id = sessionManagement.checkSession(SID);
@@ -893,7 +898,7 @@ public class MainService implements IPen
* @param email
* @param subject
* @param room_id
- * @return
+ * @return - "success" string in case of success, error message of null otherwise
*/
@Deprecated
public String sendInvitation(String SID, String username, String message,
@@ -913,7 +918,7 @@ public class MainService implements IPen
* @param username
* @param message
* @param email
- * @return
+ * @return - "success" string in case of success, error message of null otherwise
*/
public String sendFeedback(String SID, String username, String message,
String email) {
@@ -933,7 +938,7 @@ public class MainService implements IPen
/**
* @deprecated
* @param SID
- * @return
+ * @return - map of rss messages
*/
@Deprecated
public LinkedHashMap<String, LinkedHashMap<String, LinkedHashMap<String, LinkedHashMap<String, Object>>>> getRssFeeds(
@@ -947,7 +952,7 @@ public class MainService implements IPen
*
* @param SID
* @param urlEndPoint
- * @return
+ * @return - map of rss messages
*/
public LinkedHashMap<String, LinkedHashMap<String, LinkedHashMap<String, Object>>> getRssFeedByURL(
String SID, String urlEndPoint) {
@@ -966,7 +971,7 @@ public class MainService implements IPen
* @deprecated
* @param SID
* @param domain
- * @return
+ * @return - empty map
*/
@Deprecated
public LinkedHashMap<Integer, RoomClient> getUsersByDomain(String SID,
Modified: incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/OrganisationService.java
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/OrganisationService.java?rev=1417528&r1=1417527&r2=1417528&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/OrganisationService.java (original)
+++ incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/OrganisationService.java Wed Dec 5 17:06:00 2012
@@ -52,10 +52,10 @@ public class OrganisationService {
private AuthLevelmanagement authLevelManagement;
/**
- * Loads a List of all availible Organisations (ADmin-role only)
+ * Loads a List of all available Organizations (Admin-role only)
*
* @param SID
- * @return
+ * @return - List of all available Organizations
*/
public SearchResult<Organisation> getOrganisations(String SID, int start, int max,
String orderby, boolean asc) {
@@ -86,7 +86,7 @@ public class OrganisationService {
*
* @param SID
* @param organisation_id
- * @return
+ * @return - organisation with given id
*/
public Organisation getOrganisationById(String SID, long organisation_id) {
Long users_id = sessionManagement.checkSession(SID);
@@ -100,7 +100,7 @@ public class OrganisationService {
*
* @param SID
* @param organisation_id
- * @return
+ * @return - id of organisation in case of success, null otherwise
*/
public Long deleteOrganisation(String SID, long organisation_id) {
Long users_id = sessionManagement.checkSession(SID);
@@ -113,9 +113,8 @@ public class OrganisationService {
* adds or updates an Organisation
*
* @param SID
- * @param organisation_id
- * @param orgname
- * @return
+ * @param regObjectObj
+ * @return - id of added or updated organisation in case of success, null otherwise
*/
public Long saveOrUpdateOrganisation(String SID, Object regObjectObj) {
try {
@@ -149,7 +148,7 @@ public class OrganisationService {
* @param max
* @param orderby
* @param asc
- * @return
+ * @return all users of a given organisation
*/
public SearchResult<Users> getUsersByOrganisation(String SID,
long organisation_id, int start, int max, String orderby,
Modified: incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/UserService.java
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/UserService.java?rev=1417528&r1=1417527&r2=1417528&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/UserService.java (original)
+++ incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/UserService.java Wed Dec 5 17:06:00 2012
@@ -141,8 +141,7 @@ public class UserService {
* get your own user-object
*
* @param SID
- * @param user_id
- * @return
+ * @return get the user bound to this session
*/
public Users getUserSelf(String SID) {
Long users_id = sessionManagement.checkSession(SID);
@@ -170,7 +169,7 @@ public class UserService {
*
* @param SID
* @param user_id
- * @return
+ * @return User with the id given
*/
public Users getUserById(String SID, long user_id) {
Long users_id = sessionManagement.checkSession(SID);
@@ -182,7 +181,7 @@ public class UserService {
* refreshes the current SID
*
* @param SID
- * @return
+ * @return "ok" string in case of success, "error" string in case of the error
*/
public String refreshSession(String SID) {
try {
@@ -198,7 +197,7 @@ public class UserService {
* get all availible Salutations
*
* @param SID
- * @return
+ * @return all availible Salutations
*/
public List<Salutations> getUserSalutations(String SID, long language_id) {
return salutationmanagement.getUserSalutations(language_id);
@@ -215,7 +214,7 @@ public class UserService {
* @param orderby
* login,lastname,firstname,user_id
* @param asc
- * @return
+ * @return List of the users found
*/
public List<Users> searchUser(String SID, String searchcriteria,
String searchstring, int max, int start, String orderby, boolean asc) {
@@ -234,7 +233,7 @@ public class UserService {
* @param max
* @param orderby
* @param asc
- * @return
+ * @return list of all users of an organisation
*/
public List<Users> getOrgUserList(String SID, long organisation_id,
int start, int max, String orderby, boolean asc) {
@@ -249,7 +248,7 @@ public class UserService {
}
/**
- * gat a list of all organisations of an user
+ * get a list of all organisations of an user
*
* @param SID
* @param client_user
@@ -257,7 +256,7 @@ public class UserService {
* @param max
* @param orderby
* @param asc
- * @return
+ * @return list of all organisations of an user
*/
public List<Organisation> getOrganisationListByUser(String SID,
long client_user, int start, int max, String orderby, boolean asc) {
@@ -276,7 +275,7 @@ public class UserService {
* @param max
* @param orderby
* @param asc
- * @return
+ * @return list of all not assigned organisations of a user
*/
public List<Organisation> getRestOrganisationListByUser(String SID,
long client_user, int start, int max, String orderby, boolean asc) {
@@ -293,7 +292,7 @@ public class UserService {
* @param start
* @param max
* @param orderby
- * @return
+ * @return whole user-list
*/
public SearchResult<Users> getUserList(String SID, int start, int max,
String orderby, boolean asc) {
@@ -319,7 +318,7 @@ public class UserService {
* @param start
* @param max
* @param orderby
- * @return
+ * @return user-list by search criteria
*/
public SearchResult<Users> getAllUserBySearchRange(String SID,
String search, int start, int max, String orderby, boolean asc) {
@@ -331,7 +330,7 @@ public class UserService {
* updates the user profile, every user can update his own profile
*
* @param SID
- * @param argObject
+ * @param values
* @return user_id or NULL or negativ value (error_id)
*/
public Long updateUserSelfSmall(String SID,
@@ -355,7 +354,7 @@ public class UserService {
*
* @param SID
* @param regObjectObj
- * @return
+ * @return - id of the user updated in case of success, null otherwise
*/
@SuppressWarnings({ "rawtypes" })
public Long saveOrUpdateUser(String SID, Object regObjectObj) {
@@ -501,7 +500,7 @@ public class UserService {
*
* @param SID
* @param user_idClient
- * @return
+ * @return - id of the user deleted in case of success, error code otherwise
*/
public Long deleteUserAdmin(String SID, Long user_idClient) {
log.debug("deleteUserAdmin");
@@ -539,7 +538,7 @@ public class UserService {
* @param serverId
* 0 means the session is locally, otherwise we have to perform a
* REST call
- * @return
+ * @return - true if user has sufficient permissions, false otherwise
*/
public Boolean kickUserByStreamId(String SID, String streamid, long serverId) {
try {
@@ -1708,7 +1707,7 @@ public class UserService {
*
* @param SID
* @param publicSID
- * @return
+ * @return - true in case user have sufficient permissions, null otherwise
*/
public Boolean kickUserByPublicSID(String SID, String publicSID) {
try {
Modified: incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/WhiteBoardService.java
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/WhiteBoardService.java?rev=1417528&r1=1417527&r2=1417528&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/WhiteBoardService.java (original)
+++ incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/WhiteBoardService.java Wed Dec 5 17:06:00 2012
@@ -210,7 +210,7 @@ public class WhiteBoardService implement
* @param SID
* @param publicSID
* @param canDraw
- * @return
+ * @return null in case of success, false otherwise
*/
public Boolean setCanDraw(String SID, String publicSID, boolean canDraw) {
try {
Modified: incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/red5/ScopeApplicationAdapter.java
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/red5/ScopeApplicationAdapter.java?rev=1417528&r1=1417527&r2=1417528&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/red5/ScopeApplicationAdapter.java (original)
+++ incubator/openmeetings/trunk/singlewebapp/src/org/apache/openmeetings/remote/red5/ScopeApplicationAdapter.java Wed Dec 5 17:06:00 2012
@@ -426,7 +426,7 @@ public class ScopeApplicationAdapter ext
/**
* this function is invoked directly after initial connecting
*
- * @return
+ * @return publicSID of current client
*/
public synchronized String getPublicSID() {
IConnection current = Red5.getConnectionLocal();
@@ -656,8 +656,9 @@ public class ScopeApplicationAdapter ext
* This method handles the Event after a stream has been added all connected
* Clients in the same room will get a notification
*
- * @return void
- *
+ */
+ /* (non-Javadoc)
+ * @see org.red5.server.adapter.MultiThreadedApplicationAdapter#streamPublishStart(org.red5.server.api.stream.IBroadcastStream)
*/
@Override
public synchronized void streamPublishStart(IBroadcastStream stream) {
@@ -767,8 +768,9 @@ public class ScopeApplicationAdapter ext
* This method handles the Event after a stream has been removed all
* connected Clients in the same room will get a notification
*
- * @return void
- *
+ */
+ /* (non-Javadoc)
+ * @see org.red5.server.adapter.MultiThreadedApplicationAdapter#streamBroadcastClose(org.red5.server.api.stream.IBroadcastStream)
*/
@Override
public synchronized void streamBroadcastClose(IBroadcastStream stream) {
@@ -898,7 +900,7 @@ public class ScopeApplicationAdapter ext
* Adds a Moderator by its publicSID
*
* @param publicSID
- * @return
+ * @return -1
*/
public synchronized Long addModerator(String publicSID) {
try {
@@ -1277,9 +1279,14 @@ public class ScopeApplicationAdapter ext
* audio a - audio only v - video only n - no a/v only static image
* furthermore
*
- * @param avsetting
+ * @param avsettings
* @param newMessage
- * @return
+ * @param vWidth
+ * @param vHeight
+ * @param room_id
+ * @param publicSID
+ * @param interviewPodId
+ * @return RoomClient being updated in case of no errors, null otherwise
*/
public synchronized RoomClient setUserAVSettings(String avsettings,
Object newMessage, Integer vWidth, Integer vHeight,
@@ -1408,9 +1415,13 @@ public class ScopeApplicationAdapter ext
* and all the informations about the new user is send to every user of the
* current conference room<br/>
* <br/>
- * @param room_id
- * @param colorObj
- * @return
+ *
+ * @param room_id - id of the room
+ * @param becomeModerator - is user will become moderator
+ * @param isSuperModerator - is user super moderator
+ * @param organization_id - organization id of the user
+ * @param colorObj - some color
+ * @return RoomStatus object
*/
public synchronized RoomStatus setRoomValues(Long room_id,
Boolean becomeModerator, Boolean isSuperModerator,
@@ -1702,7 +1713,7 @@ public class ScopeApplicationAdapter ext
* @param firstname
* @param lastname
* @param picture_uri
- * @return
+ * @return client being updated in case of success, null otherwise
*/
public synchronized RoomClient setUsernameReconnect(String SID,
Long userId, String username, String firstname, String lastname,
@@ -1748,12 +1759,12 @@ public class ScopeApplicationAdapter ext
/**
* this is set initial directly after login/loading language
*
- * @param userId
- * @param username
- * @param firstname
- * @param lastname
- * @param orgdomain
- * @return
+ * @param SID - id of the session
+ * @param userId - id of the user being set
+ * @param username - username of the user
+ * @param firstname - firstname of the user
+ * @param lastname - lastname of the user
+ * @return RoomClient in case of everything is OK, null otherwise
*/
public synchronized RoomClient setUsernameAndSession(String SID,
Long userId, String username, String firstname, String lastname) {
@@ -1800,7 +1811,7 @@ public class ScopeApplicationAdapter ext
*
* @param room_id
* @param message
- * @return
+ * @return the list of room clients
*/
public synchronized HashMap<String, RoomClient> sendMessageByRoomAndDomain(
Long room_id, Object message) {
@@ -1882,8 +1893,7 @@ public class ScopeApplicationAdapter ext
/**
* This Function is triggered from the Whiteboard
*
- * @param whiteboardObj
- * @return
+ * @param whiteboardObjParam - array of parameters being sended to whiteboard
*/
@SuppressWarnings({ "rawtypes", "unchecked" })
public synchronized void sendVars(ArrayList whiteboardObjParam) {
@@ -1985,8 +1995,8 @@ public class ScopeApplicationAdapter ext
/**
* This Function is triggered from the Whiteboard
*
- * @param whiteboardObj
- * @return
+ * @param whiteboardObjParam - array of parameters being sended to whiteboard
+ * @param whiteboardId - id of whiteboard parameters will be send to
*/
@SuppressWarnings({ "rawtypes", "unchecked" })
public synchronized void sendVarsByWhiteboardId(
@@ -2197,7 +2207,7 @@ public class ScopeApplicationAdapter ext
/**
* send status for shared browsing to all members except self
* @param newMessage
- * @return
+ * @return 1
*/
@SuppressWarnings({ "rawtypes" })
public synchronized int sendBrowserMessageToMembers(Object newMessage) {
@@ -2265,7 +2275,7 @@ public class ScopeApplicationAdapter ext
* @param remoteMethodName
* @param newMessage
* @param sendSelf
- * @return
+ * @return true
*/
@Deprecated
public synchronized boolean loadTestSyncMessage(String remoteMethodName, Object newMessage, boolean sendSelf) {
@@ -2334,7 +2344,7 @@ public class ScopeApplicationAdapter ext
/**
* wrapper method
* @param newMessage
- * @return
+ * @return 1 in case of success, -1 otherwise
*/
public synchronized int sendMessageWithClient(Object newMessage) {
try {
@@ -2351,7 +2361,7 @@ public class ScopeApplicationAdapter ext
* wrapper method
* @param newMessage
* @param sync
- * @return
+ * @return 1 in case of success, -1 otherwise
*/
public synchronized int sendMessageWithClientWithSyncObject(Object newMessage, boolean sync) {
try {
@@ -2379,7 +2389,7 @@ public class ScopeApplicationAdapter ext
*
* @param newMessage
* @param clientId
- * @return
+ * @return 1 in case of success, -1 otherwise
*/
public synchronized int sendMessageById(Object newMessage, String clientId,
IScope scope) {
@@ -2431,7 +2441,7 @@ public class ScopeApplicationAdapter ext
*
* @param newMessage
* @param clientId
- * @return
+ * @return 1 in case of no exceptions, -1 otherwise
*/
public synchronized int sendMessageWithClientById(Object newMessage,
String clientId) {
@@ -2790,7 +2800,7 @@ public class ScopeApplicationAdapter ext
/**
* Stop the recording of the streams and send event to connected users of scope
*
- * @return
+ * @return true if interview was found
*/
public synchronized Boolean stopInterviewRecording() {
try {
@@ -2868,7 +2878,7 @@ public class ScopeApplicationAdapter ext
* Get all ClientList Objects of that room and domain Used in
* lz.applyForModeration.lzx
*
- * @return
+ * @return all ClientList Objects of that room and domain
*/
public synchronized List<RoomClient> getClientListScope() {
try {