|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface UserDefinedLogEntry
Interface for a UserDefinedLogEntry object
Field Summary | |
---|---|
static java.lang.String |
copyright
|
Method Summary | |
---|---|
void |
delete()
Deletes the UserDefinedLogEntry |
java.util.Date |
getDate()
Fetches the date and time at which this UserDefinedLogEntry was created or last updated. |
Category |
getTargetCategory()
Fetches the category to which this UserDefinedLogEntry is associated. |
Item |
getTargetItem()
Fetches the item to which this UserDefinedLogEntry is associated. |
java.lang.String |
getValue()
Returns the string description stored in this log entry |
void |
setDate(java.util.Date date)
Sets the date for the UserDefinedLogEntry. |
void |
setValue(java.lang.String logValue)
Store a string with this log entry, overwriting any previous string. |
Field Detail |
---|
static final java.lang.String copyright
Method Detail |
---|
void delete()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future usevoid setValue(java.lang.String logValue)
logValue
- -
The string value to be recorded in this log entry
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use
java.lang.IllegalArgumentException
- If logValue is nulljava.lang.String getValue()
PIMInternalException
- If an internal error occursjava.util.Date getDate()
PIMInternalException
- If an internal error occurs.void setDate(java.util.Date date)
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future use
java.lang.IllegalArgumentException
- If date is nullItem getTargetItem()
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_VIEW_ITEMS
java.lang.UnsupportedOperationException
- If the UserDefinedLogEntry is associated with a category and
not with an item.Category getTargetCategory()
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_VIEW_HIERARCHY_NODES
java.lang.UnsupportedOperationException
- If the UserDefinedLogEntry is associated with an item and not
with a category.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |