Package org.openwms.core.preferences.impl.file

Class RolePreference

java.lang.Object

org.openwms.core.preferences.impl.file.AbstractPreference

org.openwms.core.preferences.impl.file.GenericPreference

org.openwms.core.preferences.impl.file.RolePreference

All Implemented Interfaces:

Serializable

public class RolePreference
extends GenericPreference
implements Serializable

A RolePreference is used to provide settings specific to an Role . These kind of Preferences is valid for the assigned Role only. Users assigned to a Role inherit these RolePreferences but a RolePreference can be overruled by an UserPreference. RolePreferences can be defined within a preferences file but also be created with the UI.

Author:

Heiko Scherrer

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private String	key	Key value of the RolePreference.
private String	owner	Owner of the RolePreference.

Fields inherited from class org.openwms.core.preferences.impl.file.GenericPreference

description, maximum, minimum, type, value

Constructor Summary

Constructors

Constructor	Description
RolePreference()	Create a new RolePreference.
RolePreference(String rolename, String key)	Create a new RolePreference.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
protected Object[]	getFields()	Return all fields as an array of objects.
String	getKey()	Get the key.
String	getOwner()	Get the name of the Role as String.
PreferenceKey	getPrefKey()	Return a PreferenceKey of this preference.
int	hashCode()
void	setKey(String key)
void	setOwner(String owner)
String	toString()

Methods inherited from class org.openwms.core.preferences.impl.file.GenericPreference

getDescription, getMaximum, getMinimum, getType, getValue, setDescription, setMaximum, setMinimum, setType, setValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

owner

private String owner

Owner of the RolePreference.

key

private String key

Key value of the RolePreference.

Constructor Details

RolePreference

public RolePreference()

Create a new RolePreference. Defined for the JAXB implementation.

RolePreference

public RolePreference(String rolename,
 String key)

Create a new RolePreference.

Parameters:

rolename - The name of the Role that owns this preference

key - the key

Throws:

IllegalArgumentException - when rolename or key is null or empty

Method Details

getKey

public String getKey()

Get the key.

Returns:

the key.

setKey

public void setKey(String key)

getOwner

public String getOwner()

Get the name of the Role as String.

Returns:

the rolename.

setOwner

public void setOwner(String owner)

getFields

protected Object[] getFields()

Return all fields as an array of objects.

Specified by:

getFields in class AbstractPreference

Returns:

fields as array

See Also:

• AbstractPreference.getFields()

getPrefKey

public PreferenceKey getPrefKey()

Return a PreferenceKey of this preference.

Uses the type, owner and the key to create a PreferenceKey instance.

Specified by:

getPrefKey in class AbstractPreference

Returns:

A PreferenceKey

See Also:

• AbstractPreference.getPrefKey()

hashCode

public int hashCode()

Uses key, owner and type for hashCode calculation.

Overrides:

hashCode in class GenericPreference

See Also:

• Object.hashCode()

equals

public boolean equals(Object obj)

Comparison done with key, owner and type fields. Not delegated to super class.

Overrides:

equals in class GenericPreference

See Also:

• Object.equals(java.lang.Object)

toString

public String toString()

Use all fields.

Overrides:

toString in class GenericPreference