|
PDAP Public Review Draft | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Represents the common functionality of a PIM list.
Method Summary | |
void |
addCategory(java.lang.String category)
Adds the provided category to the PIM database. |
void |
close()
Closes the list, releasing any resources for this list. |
void |
deleteCategory(java.lang.String category)
Deletes the indicated category from the PIM database. |
Enumeration |
elements()
Return an Enumeration of all elements in the list. |
Enumeration |
elements(PIMElement matching)
Return an Enumeration of all elements in the list which match all of the fields specified in the element parameter. |
java.lang.String[] |
getCategories()
Returns the categories defined for the PIM database. |
int[] |
getSupportedFields()
Returns an int array containing all field IDs supported by this list. |
int[] |
getSupportedTypes(int fieldID)
Returns an integer array containing the supported type ids for the given field ID. |
boolean |
isExtendedField(int fieldID)
Indicates whether or not the given fieldID is an extended field or not. |
boolean |
isSupportedField(int fieldID)
Indicates whether or not the given fieldID is supported in this PIM list. |
int |
maxCategories()
Returns the maximum number of categories that this list can have. |
Method Detail |
public void close() throws PIMException
PIMException
is thrown for any subsequent method invocations
for the class instance.PIMException
- If the list is no longer accessible.public Enumeration elements() throws PIMException
PIMException
- If an error occurs or the list is no longer accessible or closed.public Enumeration elements(PIMElement matching) throws PIMException
matching
- the Element to matchPIMException
- If an error occurs or the list is no longer accessible or closed.java.lang.IllegalArgumentException
- If the Element is an illegal subclass for the appropriate list.public java.lang.String[] getCategories() throws PIMException
PIMException
- If categories are unsupported,an error occurs,
or the list is no longer accessible or closed.public void addCategory(java.lang.String category) throws PIMException
a
- String representing a category.PIMException
- If categories are unsupported, an error occurs,
or the list is no longer accessible or closed.java.lang.SecurityException
- if the application is not given permission to write to the PIM list.public void deleteCategory(java.lang.String category) throws PIMException
a
- String category.PIMException
- If categories are unsupported, an error occurs,
or the list is no longer accessible or closed.java.lang.SecurityException
- if the application is not given permission to write to the PIM list.public int maxCategories() throws PIMException
PIMException
- if the list is no longer accessible or closed.public boolean isSupportedField(int fieldID) throws PIMException
fieldID
- The fieldID to check, as defined by the PIMElement subclasses.java.lang.IllegalArgumentException
- if fieldID is an invalid ID for this list.PIMException
- if the list is closed or is no longer accessible.public boolean isExtendedField(int fieldID) throws PIMException
fieldID
- The fieldID to check, as defined by the PIMElement subclasses.java.lang.IllegalArgumentException
- if fieldID is an invalid ID for this list.PIMException
- if the list is closed or is no longer accessible.public int[] getSupportedFields() throws PIMException
PIMException
- if the list is closed or is no longer accessible.public int[] getSupportedTypes(int fieldID) throws PIMException
fieldID
- the fieldID to checkjava.lang.IllegalArgumentException
- if fieldID is is not one of the
the valid field IDs for the implementing class.PIMException
- if the list is closed or is no longer accessible.
|
PDAP 1.0 Spec, Rev. 0.16 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |