|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ItemUserDefinedLog
Interface representing a UserDefinedLog object that holds log entries for items.
Field Summary |
---|
Fields inherited from interface com.ibm.pim.userdefinedlog.UserDefinedLog |
---|
copyright |
Method Summary | |
---|---|
UserDefinedLogEntry |
createLogEntry(Item item,
Category category,
java.lang.String entry)
Creates a UserDefinedLogEntry for a given item which belongs to the specific category passed as argument. |
UserDefinedLogEntry |
createLogEntry(Item item,
java.lang.String entry)
Creates a UserDefinedLogEntry for a given item.The UserDefinedLogEntry object must be persisted by calling UserDefinedLog.save() on the
containing UserDefinedLog |
void |
deleteEntries(Item item)
Deletes the UserDefinedLogEntries corresponding to the item passed as the argument. |
void |
deleteEntries(Item item,
Category category)
Deletes the UserDefinedLogEntries corresponding to the item which belongs to the specific category passed as argument. |
Catalog |
getCatalog()
Fetches the catalog with which this UserDefinedLog is associated. |
PIMCollection<UserDefinedLogEntry> |
getLogEntries(Item item)
Retrieves all UserDefinedLogEntry objects associated with a specific item |
PIMCollection<UserDefinedLogEntry> |
getLogEntries(Item item,
Category category)
Retrieves all UserDefinedLogEntry objects associated with the item which belongs to the specific category passed as argument. |
Methods inherited from interface com.ibm.pim.userdefinedlog.UserDefinedLog |
---|
accept, delete, deleteAllEntries, getDescription, getLogEntries, getName, isRunningLog, save, setDescription, setName, setRunningLog |
Method Detail |
---|
UserDefinedLogEntry createLogEntry(Item item, java.lang.String entry)
UserDefinedLog.save()
on the
containing UserDefinedLog
item
- The item 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 item is null or entry is null or if the item is not belong
to the Catalog to which this user defined log is associated
java.lang.IllegalStateException
- If the UserDefinedLog or the item has not been persistedUserDefinedLogEntry createLogEntry(Item item, Category category, java.lang.String entry)
UserDefinedLog.save()
on the
containing UserDefinedLog
item
- The item for which a new UserDefinedLogEntry has to be
created.category
- The category to which this item belongs to.entry
- The name of the user defined log entry.
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future use
java.lang.IllegalArgumentException
- If item is null or category is null or entry is null or if
the item is not belong to the Catalog to which this user
defined log is associated or if the item is not belong to the
category passed as argument
java.lang.IllegalStateException
- If the UserDefinedLog or the item or the category has not
been persistedPIMCollection<UserDefinedLogEntry> getLogEntries(Item item)
item
- The Item for which to retrieve UserDefinedLogEntry objects
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use
java.lang.IllegalArgumentException
- If item is null or if the item is not belong to the Catalog
to which this user defined log is associated
java.lang.IllegalStateException
- If the UserDefinedLog or the item has not been persistedPIMCollection<UserDefinedLogEntry> getLogEntries(Item item, Category category)
item
- The Item for which to retrieve UserDefinedLogEntry objectscategory
- The category to which the item belongs to
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use
java.lang.IllegalArgumentException
- If item is null or if the category is null or if the item is
not belong to the Catalog to which this user defined log is
associated or if the item is not belong to the category
passed as argument
java.lang.IllegalStateException
- If the UserDefinedLog or the item or the category has not
been persistedvoid deleteEntries(Item item)
item
- The UserDefinedLogEntries corresponding to this item will be
deleted.
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future use
java.lang.IllegalArgumentException
- If item is null or if the item is not belong to the Catalog
to which this user defined log is associated
java.lang.IllegalStateException
- If the UserDefinedLog or the item has not been persistedvoid deleteEntries(Item item, Category category)
item
- The UserDefinedLogEntries corresponding to this item will be
deleted.category
- The category to which this item belongs to
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future use
java.lang.IllegalArgumentException
- If item is null or if the category is null or if the item is
not belong to the Catalog to which this user defined log is
associated or if the item is not belong to the category
passed as argument
java.lang.IllegalStateException
- If the UserDefinedLog or the item or the category has not
been persistedCatalog getCatalog()
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_LIST
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |