Package com.clover.sdk.v3.employees

Class IEmployeeService.Default

java.lang.Object

com.clover.sdk.v3.employees.IEmployeeService.Default

All Implemented Interfaces:

IInterface, IEmployeeService

Enclosing interface:

IEmployeeService

public static class IEmployeeService.Default
extends Object
implements IEmployeeService

Default implementation for IEmployeeService.

Nested Class Summary

Nested classes/interfaces inherited from interface com.clover.sdk.v3.employees.IEmployeeService

IEmployeeService.Default, IEmployeeService.Stub

Constructor Summary

Constructors

Constructor	Description
Default()

Method Summary

Modifier and Type	Method	Description
EmployeeCard	addEmployeeCard(EmployeeCard employeeCard, ResultStatus resultStatus)	Not available to non-Clover apps.
void	addListener(IEmployeeListener listener, ResultStatus resultStatus)	Register a listener to be called when the active employee changes, which coincides with the lockscreen being shown or dismissed.
IBinder	asBinder()
Employee	createEmployee(Employee employee, ResultStatus resultStatus)	Create a new employee.
void	deleteEmployee(String id, ResultStatus resultStatus)	Delete an existing employee.
void	deleteEmployeeCard(EmployeeCard employeeCard, ResultStatus resultStatus)	Not available to non-Clover apps.
void	deleteFingerprintId(String employeeId, ResultStatus resultStatus)	Not available to non-Clover apps.
Employee	getActiveEmployee(ResultStatus resultStatus)	Return the employee currently logged in to this device.
Employee	getEmployee(String id, ResultStatus resultStatus)	Return the employee for the particular UUID.
List<EmployeeCard>	getEmployeeCards(String employeeId, ResultStatus resultStatus)	Not available to non-Clover apps.
Employee	getEmployeeForCard(String cardNumber, ResultStatus resultStatus)	Not available to non-Clover apps.
String	getEmployeeId(int fingerprintId, ResultStatus resultStatus)	Not available to non-Clover apps.
List<Employee>	getEmployees(ResultStatus resultStatus)	Return a list of all employees.
int[]	getEnrolledFingerprints(ResultStatus resultStatus)	Not available to non-Clover apps.
int	getFingerprintId(String employeeId, ResultStatus resultStatus)	Not available to non-Clover apps.
void	login(ResultStatus resultStatus)	Deprecated. Please use Lockscreen#unlock(), Lockscreen#unlock(String), or Lockscreen#unlockDefault().
void	logout(ResultStatus resultStatus)	Deprecated. Please use Lockscreen#lock().
void	removeListener(IEmployeeListener listener, ResultStatus resultStatus)	Unregister a previously registered employee changed listener.
Employee	setEmployeePin(String id, String pin, ResultStatus resultStatus)	Deprecated. Use updateEmployee(Employee, ResultStatus) instead.
void	setFingerprintId(String employeeId, String fingerprintId, ResultStatus resultStatus)	Not available to non-Clover apps.
Employee	updateEmployee(Employee employee, ResultStatus resultStatus)	Update an existing employee.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Default

public Default()

Method Detail

getActiveEmployee

public Employee getActiveEmployee(ResultStatus resultStatus)
                           throws RemoteException

Return the employee currently logged in to this device. If the device is locked this returns null.

Specified by:

getActiveEmployee in interface IEmployeeService

Throws:

RemoteException

getEmployee

public Employee getEmployee(String id,
                            ResultStatus resultStatus)
                     throws RemoteException

Return the employee for the particular UUID.

Specified by:

getEmployee in interface IEmployeeService

Throws:

RemoteException

getEmployees

public List<Employee> getEmployees(ResultStatus resultStatus)
                            throws RemoteException

Return a list of all employees.

Specified by:

getEmployees in interface IEmployeeService

Throws:

RemoteException

createEmployee

public Employee createEmployee(Employee employee,
                               ResultStatus resultStatus)
                        throws RemoteException

Create a new employee. You must set at least a name, pin and role. Do not set the id, one will be generated and available in the return value. Device must have network connectivity to succeed.

Specified by:

createEmployee in interface IEmployeeService

Throws:

RemoteException

updateEmployee

public Employee updateEmployee(Employee employee,
                               ResultStatus resultStatus)
                        throws RemoteException

Update an existing employee. Device must have network connectivity to succeed. Check result status to ensure the call succeeded.

Specified by:

updateEmployee in interface IEmployeeService

Throws:

RemoteException

setEmployeePin

public Employee setEmployeePin(String id,
                               String pin,
                               ResultStatus resultStatus)
                        throws RemoteException

Deprecated.

Use updateEmployee(Employee, ResultStatus) instead.

Specified by:

setEmployeePin in interface IEmployeeService

Throws:

RemoteException

deleteEmployee

public void deleteEmployee(String id,
                           ResultStatus resultStatus)
                    throws RemoteException

Delete an existing employee. Device must have network connectivity to succeed. Check result status to ensure the call succeeded.

Specified by:

deleteEmployee in interface IEmployeeService

Throws:

RemoteException

logout

public void logout(ResultStatus resultStatus)
            throws RemoteException

Deprecated.

Please use Lockscreen#lock().

Specified by:

logout in interface IEmployeeService

Throws:

RemoteException

login

public void login(ResultStatus resultStatus)
           throws RemoteException

Deprecated.

Please use Lockscreen#unlock(), Lockscreen#unlock(String), or Lockscreen#unlockDefault().

Specified by:

login in interface IEmployeeService

Throws:

RemoteException

addListener

public void addListener(IEmployeeListener listener,
                        ResultStatus resultStatus)
                 throws RemoteException

Register a listener to be called when the active employee changes, which coincides with the lockscreen being shown or dismissed.

Specified by:

addListener in interface IEmployeeService

Throws:

RemoteException

removeListener

public void removeListener(IEmployeeListener listener,
                           ResultStatus resultStatus)
                    throws RemoteException

Unregister a previously registered employee changed listener.

Specified by:

removeListener in interface IEmployeeService

Throws:

RemoteException

addEmployeeCard

public EmployeeCard addEmployeeCard(EmployeeCard employeeCard,
                                    ResultStatus resultStatus)
                             throws RemoteException

Not available to non-Clover apps.

Specified by:

addEmployeeCard in interface IEmployeeService

Throws:

RemoteException

deleteEmployeeCard

public void deleteEmployeeCard(EmployeeCard employeeCard,
                               ResultStatus resultStatus)
                        throws RemoteException

Not available to non-Clover apps.

Specified by:

deleteEmployeeCard in interface IEmployeeService

Throws:

RemoteException

getEmployeeCards

public List<EmployeeCard> getEmployeeCards(String employeeId,
                                           ResultStatus resultStatus)
                                    throws RemoteException

Not available to non-Clover apps.

Specified by:

getEmployeeCards in interface IEmployeeService

Throws:

RemoteException

getEmployeeForCard

public Employee getEmployeeForCard(String cardNumber,
                                   ResultStatus resultStatus)
                            throws RemoteException

Not available to non-Clover apps.

Specified by:

getEmployeeForCard in interface IEmployeeService

Throws:

RemoteException

setFingerprintId

public void setFingerprintId(String employeeId,
                             String fingerprintId,
                             ResultStatus resultStatus)
                      throws RemoteException

Not available to non-Clover apps. Set a fingerprint for an employee.

Specified by:

setFingerprintId in interface IEmployeeService

Parameters:

employeeId - , the employee's ID for whom this fingerprint is set.

fingerprintId - , the fingerprint ID.

resultStatus - , Possible status results from calling Clover services. Most Clover service calls accept an instance of the ResultStatus class as an "out" parameter

Throws:

RemoteException

deleteFingerprintId

public void deleteFingerprintId(String employeeId,
                                ResultStatus resultStatus)
                         throws RemoteException

Not available to non-Clover apps. Delete the fingerprint of an employee.

Specified by:

deleteFingerprintId in interface IEmployeeService

Parameters:

employeeId - , the employee's ID for whom this fingerprint is set.

resultStatus - , Possible status results from calling Clover services. Most Clover service calls accept an instance of the ResultStatus class as an "out" parameter

Throws:

RemoteException

getFingerprintId

public int getFingerprintId(String employeeId,
                            ResultStatus resultStatus)
                     throws RemoteException

Not available to non-Clover apps. Get the fingerprint of an employee.

Specified by:

getFingerprintId in interface IEmployeeService

Parameters:

employeeId - , the employee's ID for whom this fingerprint is set.

resultStatus - , Possible status results from calling Clover services. Most Clover service calls accept an instance of the ResultStatus class as an "out" parameter

Throws:

RemoteException

getEnrolledFingerprints

public int[] getEnrolledFingerprints(ResultStatus resultStatus)
                              throws RemoteException

Not available to non-Clover apps. Get all the enrolled fingerprints in merchant db.

Specified by:

getEnrolledFingerprints in interface IEmployeeService

Parameters:

resultStatus - , Possible status results from calling Clover services. Most Clover service calls accept an instance of the ResultStatus class as an "out" parameter

Throws:

RemoteException

getEmployeeId

public String getEmployeeId(int fingerprintId,
                            ResultStatus resultStatus)
                     throws RemoteException

Not available to non-Clover apps. Get employeeId using the fingerprintId.

Specified by:

getEmployeeId in interface IEmployeeService

Parameters:

fingerprintId - , the fingerprint ID of the employee.

resultStatus - , Possible status results from calling Clover services. Most Clover service calls accept an instance of the ResultStatus class as an "out" parameter

Throws:

RemoteException

asBinder

public IBinder asBinder()

Specified by:

asBinder in interface IInterface