com.redhat.rhn.domain.user

Class Pane

java.lang.Object

com.redhat.rhn.domain.user.Pane

public class Pane
extends java.lang.Object

Pane. This is the domain object that contains the data represented by a Pane observed by a user. Note this class directly maps to RHNINFOPANE thorough hibernate

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	ALL_PANES
static java.lang.String	CRITICAL_SYSTEMS
static java.lang.String	INACTIVE_SYSTEMS
static java.lang.String	LATEST_ERRATA
static java.lang.String	PENDING_ACTIONS
static java.lang.String	RECENTLY_REGISTERED_SYSTEMS
static java.lang.String	SYSTEM_GROUPS
static java.lang.String	TASKS

Constructor Summary

Constructors

Constructor and Description
Pane()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) One important thing to note though is that only the Pane id is used to differentiate between 2 Panes
java.lang.String	getAcl() Retrieves the ACL values- set of conditions that determine whether the given pane should be visible to the user or not..
java.lang.String	getDescriptionKey() Retrieves the key that should be used by the LocalizationService to retrieve the 'Description' value.
java.lang.Long	getId() Retrieves id which is the primary key.
java.lang.String	getLabel() Retrieves the Label prefix.
java.lang.String	getNameKey() Retrieves the key that should be used by the LocalizationService to retrieve the 'Name' value.
int	hashCode()
boolean	isValidFor(User user) This method determines if the given pane should be viewable to the current user
static Pane	makeKey(java.lang.Long id) Returns a Dummy Instance of the Pane object, populating only the id column.

Methods inherited from class java.lang.Object

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

Field Detail

TASKS

public static final java.lang.String TASKS

See Also:

Constant Field Values

CRITICAL_SYSTEMS

public static final java.lang.String CRITICAL_SYSTEMS

See Also:

Constant Field Values

SYSTEM_GROUPS

public static final java.lang.String SYSTEM_GROUPS

See Also:

Constant Field Values

LATEST_ERRATA

public static final java.lang.String LATEST_ERRATA

See Also:

Constant Field Values

INACTIVE_SYSTEMS

public static final java.lang.String INACTIVE_SYSTEMS

See Also:

Constant Field Values

PENDING_ACTIONS

public static final java.lang.String PENDING_ACTIONS

See Also:

Constant Field Values

RECENTLY_REGISTERED_SYSTEMS

public static final java.lang.String RECENTLY_REGISTERED_SYSTEMS

See Also:

Constant Field Values

ALL_PANES

public static final java.lang.String[] ALL_PANES

Constructor Detail

Pane

public Pane()

Method Detail

makeKey

public static Pane makeKey(java.lang.Long id)

Returns a Dummy Instance of the Pane object, populating only the id column. This is useful for when the Pane object is used in a compare. If you see the equal's method, you notice that 2 Panes are considered equal if their id's are equal. So if I have a set of panes and want to retrieve the correct one, I can say something like panes.get(Pane.makeKey(Long.valueOf(10)));

Parameters:

id - the Id value of the desired pane.

Returns:

a new instance of the Pane object with the give ID.

getId

public java.lang.Long getId()

Retrieves id which is the primary key. Maps to RHNINFOPANE.ID

Returns:

id of the Pane

getLabel

public java.lang.String getLabel()

Retrieves the Label prefix. see the description of field 'label' for more information.

Returns:

the Label prefix

getNameKey

public java.lang.String getNameKey()

Retrieves the key that should be used by the LocalizationService to retrieve the 'Name' value. Something like localizationService.get(pane.getNameKey())

Returns:

key in the format preferences.${label}.name

getDescriptionKey

public java.lang.String getDescriptionKey()

Retrieves the key that should be used by the LocalizationService to retrieve the 'Description' value. Something like localizationService.get(pane.getDescriptionKey())

Returns:

key in the format preferences.${label}.description

getAcl

public java.lang.String getAcl()

Retrieves the ACL values- set of conditions that determine whether the given pane should be visible to the user or not.. see the field description for more info.

Returns:

a string in the ACL format or null if none exists for the pane.

isValidFor

public boolean isValidFor(User user)

This method determines if the given pane should be viewable to the current user

Parameters:

user - the logged in user.

Returns:

true if the pane is to be accessible.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

One important thing to note though is that only the Pane id is used to differentiate between 2 Panes

Overrides:

equals in class java.lang.Object