org.palo.api
Interface Subset

All Superinterfaces:
NamedEntity

Deprecated. this subset definition is no longer supported. Please use Subset2 instead

public interface Subset
extends NamedEntity

Subsets define a sort of Element filter for a Dimension, i.e. they determine those elements which should be shown within a gui.

So each subset has a corresponding source dimension. Furthermore it is possible to add several SubsetStates to store and restore more than one state.

Version:
$Id: Subset.html,v 1.19 2009/07/09 11:01:46 ArndHouben Exp $

Method Summary
 void addState(SubsetState state)
          Deprecated. Adds the given SubsetState to the list of all used states
 SubsetState getActiveState()
          Deprecated. Returns the last used SubsetState
 Attribute getAlias()
          Deprecated. Sets an optional alias for element name display of the subset.
 java.lang.String getDescription()
          Deprecated. Returns the subset description or null if no description was set.
 Dimension getDimension()
          Deprecated. use getHierarchy() instead.
 Hierarchy getHierarchy()
          Deprecated. Returns the corresponding Hierarchy instance
 java.lang.String getId()
          Deprecated. The unique subset id.
 java.lang.String getName()
          Deprecated. Returns the name of the subset
 SubsetState getState(java.lang.String stateId)
          Deprecated. Note returns null if no SubsetState with given id was added before!
 SubsetState[] getStates()
          Deprecated. Returns all available SubsetStates for this subset.
 void removeState(SubsetState state)
          Deprecated. Removes the given SubsetState from the list of all used states
 void save()
          Deprecated. Saves the current subset state
 void setActiveState(SubsetState activeState)
          Deprecated. Sets the last used state.
 void setAlias(Attribute alias)
          Deprecated. Gets the alias for element name display of the subset.
 void setDescription(java.lang.String description)
          Deprecated. Sets an optional description for the subset.
 void setName(java.lang.String name)
          Deprecated. Sets the subset name
 

Method Detail

getId

java.lang.String getId()
Deprecated. 
The unique subset id.

Returns:
the subset id

setName

void setName(java.lang.String name)
Deprecated. 
Sets the subset name

Parameters:
name - the subset name

getName

java.lang.String getName()
Deprecated. 
Returns the name of the subset

Specified by:
getName in interface NamedEntity
Returns:
the subset name

setDescription

void setDescription(java.lang.String description)
Deprecated. 
Sets an optional description for the subset.

Parameters:
description - the subset description

getDescription

java.lang.String getDescription()
Deprecated. 
Returns the subset description or null if no description was set.

Returns:
the subset description or null

getAlias

Attribute getAlias()
Deprecated. 
Sets an optional alias for element name display of the subset.

Returns:
attribute to be used for the alias

setAlias

void setAlias(Attribute alias)
Deprecated. 
Gets the alias for element name display of the subset.

Parameters:
alias - the attribute for the current alias.

getDimension

Dimension getDimension()
Deprecated. use getHierarchy() instead.

Returns the corresponding Dimension instance

Returns:
the dimension to which this subset applies

getHierarchy

Hierarchy getHierarchy()
Deprecated. 
Returns the corresponding Hierarchy instance

Returns:
the hierarchy to which this subset applies

addState

void addState(SubsetState state)
Deprecated. 
Adds the given SubsetState to the list of all used states

Parameters:
state - a subset state

removeState

void removeState(SubsetState state)
Deprecated. 
Removes the given SubsetState from the list of all used states

Parameters:
state - a subset state

getStates

SubsetState[] getStates()
Deprecated. 
Returns all available SubsetStates for this subset.

Returns:
an array of SubsetStates

getState

SubsetState getState(java.lang.String stateId)
Deprecated. 
Note returns null if no SubsetState with given id was added before!

Parameters:
stateId - a valid state id
Returns:
the SubsetState with given id or null if no such state exists

getActiveState

SubsetState getActiveState()
Deprecated. 
Returns the last used SubsetState

Returns:
the active SubsetState

setActiveState

void setActiveState(SubsetState activeState)
Deprecated. 
Sets the last used state. Note that the given state is also added to the list of all states if it was not present before...

Parameters:
activeState - the used SubsetState

save

void save()
Deprecated. 
Saves the current subset state