|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SubsetHandler
SubsetHandler
This interface defines all methods to handle Subset2
related
functionalities.
Method Summary | |
---|---|
Subset2 |
addSubset(java.lang.String name,
int type)
Adds a new Subset2 with the given name and type to this hierarchy |
boolean |
canRead(int type)
Checks if the user is allowed to read subsets of given type |
boolean |
canWrite(int type)
Checks if the user is allowed to write subsets of given type |
Dimension |
getDimension()
Deprecated. use getHierarchy() instead. |
Hierarchy |
getHierarchy()
Returns the Hierarchy to which this
SubsetHandler is registered. |
Subset2 |
getSubset(java.lang.String id,
int type)
Returns the Subset2 instance which is registered with the
given id and for the given type or null if no subset with
this id could be found or new subsets are not supported |
java.lang.String |
getSubsetId(java.lang.String name,
int type)
Checks if a subset with the given name and type already exists for this hierarchy and returns its id. |
java.lang.String[] |
getSubsetIDs()
Returns the IDs of all locally and globally registered Subset2 s |
java.lang.String[] |
getSubsetIDs(int type)
Returns the IDs of all registered Subset2 s of given type |
java.lang.String |
getSubsetName(java.lang.String id)
Returns the name of the subset which is registered for the given id or null |
java.lang.String[] |
getSubsetNames()
Returns the names of all locally and globally registered Subset2 s |
java.lang.String[] |
getSubsetNames(int type)
Returns the names of all registered Subset2 s of given type |
Subset2[] |
getSubsets()
Returns all Subset2 s which are currently registered with this
hierarchy. |
Subset2[] |
getSubsets(int type)
Returns all Subset2 s of the given type which are registered with
this hierarchy. |
boolean |
hasSubsets(int type)
Checks if there are any subsets of the given type |
void |
remove(java.lang.String id,
int type)
Removes the subset specified by the given id and type. |
void |
remove(Subset2 subset)
Removes the given subset |
void |
reset()
Resets this SubsetHandler . |
void |
save(Subset2 subset)
Saves the given subset |
Method Detail |
---|
Dimension getDimension()
getHierarchy()
instead.
Dimension
to which this
SubsetHandler
is registered.
Dimension
of this SubsetHandler
.Hierarchy getHierarchy()
Hierarchy
to which this
SubsetHandler
is registered.
Hierarchy
of this SubsetHandler
.void reset()
SubsetHandler
. This will clear all internally
used caches too.
java.lang.String getSubsetId(java.lang.String name, int type)
name
- a subset nametype
- one of the defined subset type constants
null
otherwiseSubset2 addSubset(java.lang.String name, int type)
Subset2
with the given name and type to this hierarchy
name
- the name of the subsettype
- one of the defined subset type constants
InsufficientRightsException
Subset2[] getSubsets()
Subset2
s which are currently registered with this
hierarchy. This method tries to load all locally and globally defined
subsets. Subsets which cannot be loaded are ignored.
Subset2[] getSubsets(int type)
Subset2
s of the given type which are registered with
this hierarchy. Subsets which cannot be loaded are ignored.
type
- one of the defined subset type constants
Subset2 getSubset(java.lang.String id, int type)
Subset2
instance which is registered with the
given id and for the given type or null
if no subset with
this id could be found or new subsets are not supported
id
- the subset idtype
- one of the defined subset type constants
PaloIOException
java.lang.String[] getSubsetIDs()
Subset2
s
java.lang.String[] getSubsetNames()
Subset2
s
java.lang.String[] getSubsetNames(int type)
Subset2
s of given type
type
- one of the defined subset type constants
InsufficientRightsException
java.lang.String[] getSubsetIDs(int type)
Subset2
s of given type
type
- one of the defined subset type constants
InsufficientRightsException
java.lang.String getSubsetName(java.lang.String id)
null
id
- the subset id
null
if no name exists to given id or if new
subsets are not supportedboolean hasSubsets(int type)
type
- one of the defined subset type constants
true
if there are subsets of given type registered
or false
if notvoid remove(Subset2 subset)
subset
- the subset to remove
InsufficientRightsException
void remove(java.lang.String id, int type)
id
- the subset idtype
- the subset type
InsufficientRightsException
void save(Subset2 subset)
subset
- the subset to save
InsufficientRightsException
boolean canWrite(int type)
type
- one of the predefined subset type constants.
true
if user is allowed to write subsets of given
type, false
otherwiseboolean canRead(int type)
type
- one of the predefined subset type constants.
true
if user is allowed to read subsets of given
type, false
otherwise
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |