GWTApplication.client
Interface FaultService

All Superinterfaces:

com.google.gwt.user.client.rpc.RemoteService

All Known Implementing Classes:

FaultServiceImpl

public interface FaultService
extends com.google.gwt.user.client.rpc.RemoteService

Method Summary

void	addNewInstrumentToSystem(java.lang.String newInstrument)
void	addNewRole(java.lang.String emailAddress, java.lang.Integer Role)
void	addNewSystemToSystem(java.lang.String newSystem)
void	addNewUser(java.lang.String Name, java.lang.String Surname, java.lang.String EmailAddress)
AuthenticationDetails	authenticateUser(java.lang.String UserIdentifier, java.lang.String Password)
java.lang.String	calculateTotalAmountOfTimeSpentOnFault(int FaultNumber)
void	closeFault(int faultId)
java.lang.Integer	createFault(Fault newFault)
java.lang.Boolean	faultExists(int faultId, boolean isEditable)
java.util.ArrayList	getCommentDetails(java.lang.Integer DefectNumber) Get all of the comments which are associated with the specified fault
java.util.ArrayList	getDutyTechnicians(boolean getOldStaff)
Fault	getFaultDetails(java.lang.Integer defectNumber, java.lang.String locale)
FaultUpdateSnapshot	getFaultsUpdated(java.util.Date timeOfLastUpdateCheck, java.lang.String locale) Gets a list of all of the faults which have been updated since the last time that the client checked to see if the faults which it is displaying has been updated.
java.util.ArrayList	getFaultType() Return the names of all of the FaultType to the caller which are recalled from the fault database table.
FaultEntryDetails	getFullFaultHistory(int defectNumber, java.lang.String locale) Deliver the full details of a fault back to the caller
java.util.ArrayList	getInstruments(boolean allInstruments) Return the names of all of the instrument to the caller which are recalled from the fault database table.
java.util.ArrayList	getMembersOfStaffNotInGroup(java.lang.Integer GroupToExclude) Get the list of people who are not in the group specified.
java.util.ArrayList	getPostscriptPrinters() Return a list of all of the printers which are currently accesible by this machine
java.util.ArrayList	getQuickViewFaultData(int TimeWindow, java.lang.String locale) Get all faults which go back to a specific date which has been specified by the caller.
java.util.ArrayList	getSeverity() Return the names of all of the severity to the caller which are recalled from the fault database table.
java.util.ArrayList	getSites()
Solution	getSolutionDetails(java.lang.Integer DefectNumber)
java.util.ArrayList	getStaffMembers(boolean getOldStaff) Return the names of all of the staff members to the caller which are recalled from the fault database table.
java.util.ArrayList	getStates()
java.util.ArrayList	getSubscribedFaults(AuthenticationDetails authenticationDetails, java.lang.String locale) This is used to get a list of the faults which the user specified is subscribed to
java.util.ArrayList	getSupportAstronomers(boolean getOldStaff)
java.util.ArrayList	getSystems() Return the names of all of the system to the caller which are recalled from the fault database table.
java.util.ArrayList	getTelescopeOperators(boolean getOldStaff)
Workaround	getWorkaroundDetails(java.lang.Integer DefectNumber)
void	informEmailListenersFaultHasChanged(java.lang.String ContextMessage, int FaultNumber)
void	linkFault(int parentFaultId, int childFaultId)
java.util.ArrayList	performAdvancedSearch(java.util.HashMap SearchParameters, java.lang.String StartDate, java.lang.String EndDate, java.lang.String locale) Perform an advanced search across the database using the search parameters which have been specified in the input array
java.util.ArrayList	performBasicSearch(int DefectNumber, java.lang.String SearchTerms, java.lang.String DefectToSearchFor, java.lang.String StartDate, java.lang.String EndDate, java.lang.String locale) Will be used to execute a basic search across the database using the input data which has been provided
boolean	printFault(int faultId, java.lang.String printer, boolean landscape)
void	registerForFaultUpdates(java.lang.String emailAddress, int faultId)
void	resetPassword(java.lang.String emailAddress, java.lang.String confirmedPassword)
void	updateCommentDetails(Comment NewCommentDetails)
boolean	updateFault(Fault updatedFault, java.lang.String locale)
void	updateFaultSubscriptionList(AuthenticationDetails authenticationDetails, java.util.HashMap newSubscriptionStatuses)
void	updateSolutionDetails(Solution NewSolutionDetails)
void	updateWorkaroundDetails(Workaround NewWorkaroundDetails)

Method Detail

getTelescopeOperators

java.util.ArrayList getTelescopeOperators(boolean getOldStaff)
                                          throws UnableToGetListException

Throws:

UnableToGetListException

getDutyTechnicians

java.util.ArrayList getDutyTechnicians(boolean getOldStaff)
                                       throws UnableToGetListException

Throws:

UnableToGetListException

getSupportAstronomers

java.util.ArrayList getSupportAstronomers(boolean getOldStaff)
                                          throws UnableToGetListException

Throws:

UnableToGetListException

getSites

java.util.ArrayList getSites()
                             throws UnableToGetListException

Throws:

UnableToGetListException

getStates

java.util.ArrayList getStates()
                              throws UnableToGetListException

Throws:

UnableToGetListException

getInstruments

java.util.ArrayList getInstruments(boolean allInstruments)
                                   throws UnableToGetListException

Return the names of all of the instrument to the caller which are recalled from the fault database table. INSTRUMENT.

Returns:

ArrayList A array which contains objects of type Instrument.

Throws:

UnableToGetListException

getSeverity

java.util.ArrayList getSeverity()
                                throws UnableToGetListException

Return the names of all of the severity to the caller which are recalled from the fault database table. SEVERITY.

Returns:

ArrayList A array which contains objects of type Severity.

Throws:

UnableToGetListException

getFaultType

java.util.ArrayList getFaultType()
                                 throws UnableToGetListException

Return the names of all of the FaultType to the caller which are recalled from the fault database table. FAULTTYPE.

Returns:

ArrayList A array which contains objects of type FaultType.

Throws:

UnableToGetListException

getSystems

java.util.ArrayList getSystems()
                               throws UnableToGetListException

Return the names of all of the system to the caller which are recalled from the fault database table. SITES.

Returns:

ArrayList A array which contains objects of type System.

Throws:

UnableToGetListException

getStaffMembers

java.util.ArrayList getStaffMembers(boolean getOldStaff)
                                    throws UnableToGetListException

Return the names of all of the staff members to the caller which are recalled from the fault database table. STAFFMEMBER.

Returns:

ArrayList A array which contains objects of type Person.

Throws:

UnableToGetListException

createFault

java.lang.Integer createFault(Fault newFault)
                              throws UnableToCreateFaultException

Throws:

UnableToCreateFaultException

getQuickViewFaultData

java.util.ArrayList getQuickViewFaultData(int TimeWindow,
                                          java.lang.String locale)

Get all faults which go back to a specific date which has been specified by the caller.

Parameters:

TimeWindow - The date which we are to search back to. If this is set to null then we search for all outstanding faults.

locale - The locale in which we are to search in.

Returns:

ArrayList This is an array of type fault which will contain the details of all of the faults which were found as part of the search.

updateFault

boolean updateFault(Fault updatedFault,
                    java.lang.String locale)
                    throws UnableToUpdateFaultException

Throws:

UnableToUpdateFaultException

getFaultDetails

Fault getFaultDetails(java.lang.Integer defectNumber,
                      java.lang.String locale)

getSolutionDetails

Solution getSolutionDetails(java.lang.Integer DefectNumber)

calculateTotalAmountOfTimeSpentOnFault

java.lang.String calculateTotalAmountOfTimeSpentOnFault(int FaultNumber)

updateSolutionDetails

void updateSolutionDetails(Solution NewSolutionDetails)

getWorkaroundDetails

Workaround getWorkaroundDetails(java.lang.Integer DefectNumber)

updateWorkaroundDetails

void updateWorkaroundDetails(Workaround NewWorkaroundDetails)

updateCommentDetails

void updateCommentDetails(Comment NewCommentDetails)

getCommentDetails

java.util.ArrayList getCommentDetails(java.lang.Integer DefectNumber)

Get all of the comments which are associated with the specified fault

Parameters:

DefectNumber - The defect number of the fault

Returns:

ArrayList This is an array of type comment which will contain the details of all of the comments which were found as part of the database query.

authenticateUser

AuthenticationDetails authenticateUser(java.lang.String UserIdentifier,
                                       java.lang.String Password)
                                       throws UserAuthenticationFailedException

Throws:

UserAuthenticationFailedException

getMembersOfStaffNotInGroup

java.util.ArrayList getMembersOfStaffNotInGroup(java.lang.Integer GroupToExclude)
                                                throws UnableToGetListException

Get the list of people who are not in the group specified.

Parameters:

GroupToExclude - The name of the group which contains the people that are to be excluded

Returns:

ArrayList An ArrayList of type Person.

Throws:

UnableToGetListException

addNewInstrumentToSystem

void addNewInstrumentToSystem(java.lang.String newInstrument)
                              throws UnableToAddInstrumentException

Throws:

UnableToAddInstrumentException

addNewSystemToSystem

void addNewSystemToSystem(java.lang.String newSystem)
                          throws UnableToAddSystemException

Throws:

UnableToAddSystemException

addNewRole

void addNewRole(java.lang.String emailAddress,
                java.lang.Integer Role)
                throws UnableToAddNewRoleException

Throws:

UnableToAddNewRoleException

addNewUser

void addNewUser(java.lang.String Name,
                java.lang.String Surname,
                java.lang.String EmailAddress)
                throws UnableToAddNewUserException

Throws:

UnableToAddNewUserException

resetPassword

void resetPassword(java.lang.String emailAddress,
                   java.lang.String confirmedPassword)
                   throws UnableToChangePasswordException

Throws:

UnableToChangePasswordException

linkFault

void linkFault(int parentFaultId,
               int childFaultId)
               throws UnknownFaultSpecifiedException,
                      java.lang.Exception

Throws:

UnknownFaultSpecifiedException

java.lang.Exception

performBasicSearch

java.util.ArrayList performBasicSearch(int DefectNumber,
                                       java.lang.String SearchTerms,
                                       java.lang.String DefectToSearchFor,
                                       java.lang.String StartDate,
                                       java.lang.String EndDate,
                                       java.lang.String locale)
                                       throws UnableToPerformSearchException

Will be used to execute a basic search across the database using the input data which has been provided

Parameters:

DefectNumber - This is the defect number for which we should return the fault information.

SearchTerms - A list of search terms which will be used to index the fault information.

StartDate - This is the start date from when to look from. This could be left blank.

EndDate - This is the end date from when to stop looking for faults.

locale - This is the locale which the user has selected

Throws:

UnableToPerformSearchException

registerForFaultUpdates

void registerForFaultUpdates(java.lang.String emailAddress,
                             int faultId)

printFault

boolean printFault(int faultId,
                   java.lang.String printer,
                   boolean landscape)
                   throws UnknownPrinterSpecifiedException

Throws:

UnknownPrinterSpecifiedException

performAdvancedSearch

java.util.ArrayList performAdvancedSearch(java.util.HashMap SearchParameters,
                                          java.lang.String StartDate,
                                          java.lang.String EndDate,
                                          java.lang.String locale)
                                          throws UnableToPerformSearchException

Perform an advanced search across the database using the search parameters which have been specified in the input array

Returns:

ArrayList A list of the parameters which match the search criteria.

Throws:

UnableToPerformSearchException

getPostscriptPrinters

java.util.ArrayList getPostscriptPrinters()

Return a list of all of the printers which are currently accesible by this machine

Returns:

ArrayList A list of the printers which can print postscript from this machine

closeFault

void closeFault(int faultId)
                throws UnableToCloseFaultException

Throws:

UnableToCloseFaultException

getFaultsUpdated

FaultUpdateSnapshot getFaultsUpdated(java.util.Date timeOfLastUpdateCheck,
                                     java.lang.String locale)

Gets a list of all of the faults which have been updated since the last time that the client checked to see if the faults which it is displaying has been updated. The epoch to check from is conveyed in the timeOfLastUpdateCheck parameter.

Returns:

ArrayList A list of the faults which have been updated.

faultExists

java.lang.Boolean faultExists(int faultId,
                              boolean isEditable)

getFullFaultHistory

FaultEntryDetails getFullFaultHistory(int defectNumber,
                                      java.lang.String locale)

Deliver the full details of a fault back to the caller

getSubscribedFaults

java.util.ArrayList getSubscribedFaults(AuthenticationDetails authenticationDetails,
                                        java.lang.String locale)

This is used to get a list of the faults which the user specified is subscribed to

Parameters:

authenticationDetails - The details of the person that has logged into the system.

Returns:

ArrayList This is a list of faults which the user is subscribed to

updateFaultSubscriptionList

void updateFaultSubscriptionList(AuthenticationDetails authenticationDetails,
                                 java.util.HashMap newSubscriptionStatuses)

informEmailListenersFaultHasChanged

void informEmailListenersFaultHasChanged(java.lang.String ContextMessage,
                                         int FaultNumber)