de.hs_rm.cs.lecturenotes.client.core.transport.service
Interface FilecardCommService

All Superinterfaces:
com.google.gwt.user.client.rpc.RemoteService
All Known Implementing Classes:
FilecardCommServiceImpl

@RemoteServiceRelativePath(value="FilecardCommService")
public interface FilecardCommService
extends com.google.gwt.user.client.rpc.RemoteService

(Synchronous) Comm Service for everything regarding the system object Filecard.

Version:
$LastChangedRevision: 242 $
Author:
Enrico Homann

Nested Class Summary
static class FilecardCommService.Util
          Utility class for simplifying access to the instance of async service.
 
Method Summary
 ResponseStatusEnum activateFilecard(long filecardId, boolean bActivate)
          Will activate or deactivate a Filecard for printing.
 ResponseStatusEnum createFilecard(Filecard entity)
          Will create a new Slide exercise in the database.
 ResponseStatusEnum deleteFilecard(Filecard entity)
          Will hard delete a new Slide exercise in the database.
 java.util.List<Filecard> getActivatedFilecardListBy(long paraId, FilecardAttributeEnum sortAttribute, SQLSortDirectionEnum sortDirection)
          Will return all activated Filecard objects for Paragraph identified by long paraId every version.
 java.util.List<Filecard> getAllActivatedFilecardListBy(long lectureId, FilecardAttributeEnum sortAttribute, SQLSortDirectionEnum sortDirection)
          Will return all activated Filecard objects for Lecture identified by long lectureId.
 java.util.List<Filecard> getOwnershipFilecardListBy(long paraId, FilecardAttributeEnum sortAttribute, SQLSortDirectionEnum sortDirection)
          Will return all Slide objects for Paragraph identified by long paraId every version.
 java.util.List<Filecard> getPendingFilecardListBy(long paraId, FilecardAttributeEnum sortAttribute, SQLSortDirectionEnum sortDirection)
          Will return all Slide objects for Paragraph identified by long paraId every version.
 ResponseStatusEnum updateFilecard(Filecard entity)
          Will update a new Filecard entity in the database.
 

Method Detail

getAllActivatedFilecardListBy

java.util.List<Filecard> getAllActivatedFilecardListBy(long lectureId,
                                                       FilecardAttributeEnum sortAttribute,
                                                       SQLSortDirectionEnum sortDirection)
                                                       throws InvalidPermissionException
Will return all activated Filecard objects for Lecture identified by long lectureId. Sorts by using the SlideAttributeEnum sortAttribute and SQLSortDirectionEnum sortDirection.

Parameters:
lectureId - long
sortAttribute - FilecardAttributeEnum
sortDirection - SQLSortDirectionEnum
Returns:
List of Filecard
Throws:
InvalidPermissionException - Thrown if caller has not the correct permissions.

getActivatedFilecardListBy

java.util.List<Filecard> getActivatedFilecardListBy(long paraId,
                                                    FilecardAttributeEnum sortAttribute,
                                                    SQLSortDirectionEnum sortDirection)
                                                    throws InvalidPermissionException
Will return all activated Filecard objects for Paragraph identified by long paraId every version. Sorts by using the SlideAttributeEnum sortAttribute and SQLSortDirectionEnum sortDirection.

Parameters:
paraId - long
sortAttribute - SlideAttributeEnum to be used in ORDER BY SQL Query statement
sortDirection - SQLSortDirectionEnum to be used in ORDER BY SQL Query statement
Returns:
List of Slide
Throws:
InvalidPermissionException - Thrown if caller has not the correct permissions.

getPendingFilecardListBy

java.util.List<Filecard> getPendingFilecardListBy(long paraId,
                                                  FilecardAttributeEnum sortAttribute,
                                                  SQLSortDirectionEnum sortDirection)
                                                  throws InvalidPermissionException
Will return all Slide objects for Paragraph identified by long paraId every version. Sorts by using the SlideAttributeEnum sortAttribute and SQLSortDirectionEnum sortDirection.

Parameters:
paraId - long
sortAttribute - SlideAttributeEnum to be used in ORDER BY SQL Query statement
sortDirection - SQLSortDirectionEnum to be used in ORDER BY SQL Query statement
Returns:
List of Slide
Throws:
InvalidPermissionException - Thrown if caller has not the correct permissions.

getOwnershipFilecardListBy

java.util.List<Filecard> getOwnershipFilecardListBy(long paraId,
                                                    FilecardAttributeEnum sortAttribute,
                                                    SQLSortDirectionEnum sortDirection)
                                                    throws InvalidPermissionException
Will return all Slide objects for Paragraph identified by long paraId every version. Sorts by using the SlideAttributeEnum sortAttribute and SQLSortDirectionEnum sortDirection.

Parameters:
paraId - long
sortAttribute - SlideAttributeEnum to be used in ORDER BY SQL Query statement
sortDirection - SQLSortDirectionEnum to be used in ORDER BY SQL Query statement
Returns:
List of Slide
Throws:
InvalidPermissionException - Thrown if caller has not the correct permissions.

createFilecard

ResponseStatusEnum createFilecard(Filecard entity)
                                  throws InvalidPermissionException
Will create a new Slide exercise in the database. The Filecard will have set the activated flag to FALSE. Returns SUCCESS at operation success, and FAILURE at operation failure.

Parameters:
entity - Filecard
Returns:
ResponseStatusEnum
Throws:
InvalidPermissionException - Thrown if caller has not the correct permissions.

updateFilecard

ResponseStatusEnum updateFilecard(Filecard entity)
                                  throws InvalidPermissionException
Will update a new Filecard entity in the database. This method does only allow the update of question and answer. Only the owner of the Filecard is allowed to update. Returns SUCCESS at operation success, and FAILURE at operation failure.

Parameters:
entity - Slide
Returns:
ResponseStatusEnum
Throws:
InvalidPermissionException - Thrown if caller has not the correct permissions.

deleteFilecard

ResponseStatusEnum deleteFilecard(Filecard entity)
                                  throws InvalidPermissionException
Will hard delete a new Slide exercise in the database. Returns SUCCESS at operation success, and FAILURE at operation failure.

Parameters:
entity - Slide
Returns:
ResponseStatusEnum
Throws:
InvalidPermissionException - Thrown if caller has not the correct permissions.

activateFilecard

ResponseStatusEnum activateFilecard(long filecardId,
                                    boolean bActivate)
                                    throws InvalidPermissionException
Will activate or deactivate a Filecard for printing. Only the Docent is allowed change the activate state of a Filecard ssociated with his Lecture. Returns SUCCESS in case of a successful operation, or FAILURE otherwise.

Parameters:
filecardId - long
bActivate - boolean
Returns:
ResponseStatusEnum
Throws:
InvalidPermissionException - Thrown if caller has not the correct permissions.