me.vertretungsplan.objects.credential

Interface Credential

All Known Implementing Classes:

BaseCredential, PasswordCredential, SchoolNumberPasswordCredential, UserPasswordCredential

public interface Credential

Method Summary

Modifier and Type	Method and Description
java.lang.String	getHash() Get a hash value for the credential data.
java.lang.String	getId()
org.joda.time.DateTime	getLastCheck()
java.lang.String	getScheduleId()
java.lang.String	getSchoolId()
boolean	isValid()
void	setLastCheck(org.joda.time.DateTime lastCheck) Set the last time this credential was checked.
void	setValid(boolean valid) Set if this credential is believed to be valid.

Method Detail

getHash

java.lang.String getHash()

Get a hash value for the credential data. This can be used to differentiate between two credentials or to allow a user to authenticate to an application which uses this parser. It should not be used by SubstitutionScheduleParser implementations, especially not if they depend on a specific hashing algorithm. For two Credential objects a and b, the following relation should apply: a.getHash().equals(b.getHash()) if and only if a.getLoginData().equals(b.getLoginData())

Returns:

Hash value for the credential data.

getSchoolId

java.lang.String getSchoolId()

getScheduleId

java.lang.String getScheduleId()

isValid

boolean isValid()

Returns:

If this credential is believed to be valid. Not necessary for any SubstitutionScheduleParser implementations.

setValid

void setValid(boolean valid)

Set if this credential is believed to be valid. Useful if your application saves credentials and checks them periodically.

Parameters:

valid - if this credential is believed to be valid

getLastCheck

org.joda.time.DateTime getLastCheck()

Returns:

The last time this credential was checked. Not necessary for any SubstitutionScheduleParser implementations.

setLastCheck

void setLastCheck(org.joda.time.DateTime lastCheck)

Set the last time this credential was checked. Useful if your application saves credentials and checks them periodically.

Parameters:

lastCheck - last time this credential was checked

getId

java.lang.String getId()