|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CategoryUserDefinedLog
Interface representing a UserDefinedLog object that holds log entries for categories.
Field Summary |
---|
Fields inherited from interface com.ibm.pim.userdefinedlog.UserDefinedLog |
---|
copyright |
Method Summary | |
---|---|
UserDefinedLogEntry |
createLogEntry(Category category,
java.lang.String entry)
Creates a UserDefinedLogEntry for a given category. |
void |
deleteEntries(Category category)
Deletes the UserDefinedLogEntries corresponding to this category. |
Hierarchy |
getHierarchy()
Fetches the hierarchy with which this UserDefinedLog is associated. |
PIMCollection<UserDefinedLogEntry> |
getLogEntries(Category category)
Fetches the UserDefinedLogEntry objects corresponding to the category passed in. |
Methods inherited from interface com.ibm.pim.userdefinedlog.UserDefinedLog |
---|
accept, delete, deleteAllEntries, getDescription, getLogEntries, getName, isRunningLog, save, setDescription, setName, setRunningLog |
Method Detail |
---|
UserDefinedLogEntry createLogEntry(Category category, java.lang.String entry)
UserDefinedLog.save()
on the
containing UserDefinedLog
category
- The category for which a new UserDefinedLogEntry has to be
created.entry
- The name of the user defined log entry.
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future use
java.lang.IllegalArgumentException
- If category is null or entry is null or if the category is
not belong to the Hierarchy to which this user defined log is
associated
java.lang.IllegalStateException
- If the UserDefinedLog or the category has not been persistedPIMCollection<UserDefinedLogEntry> getLogEntries(Category category)
category
- The UserDefinedLogEntries corresponding to this category will
be fetched.
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future use
java.lang.IllegalArgumentException
- If category is null or if the category is not belong to the
Hierarchy to which this user defined log is associated
java.lang.IllegalStateException
- If the UserDefinedLog or the category has not been persistedvoid deleteEntries(Category category)
category
- The UserDefinedLogEntries corresponding to this category will
be deleted.
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future use
java.lang.IllegalArgumentException
- If category is null or if the category is not belong to the
Hierarchy to which this user defined log is associated
java.lang.IllegalStateException
- If the UserDefinedLog or the category has not been persistedHierarchy getHierarchy()
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_LIST
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |