com.ibm.pim.userdefinedlog
Interface UserDefinedLogEntry


public interface UserDefinedLogEntry

Interface for a UserDefinedLogEntry object

Since:
6.0.0

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

copyright

static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

delete

void delete()
Deletes the UserDefinedLogEntry

Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use

setValue

void setValue(java.lang.String logValue)
Store a string with this log entry, overwriting any previous string.

Parameters:
logValue - - The string value to be recorded in this log entry
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use
java.lang.IllegalArgumentException - If logValue is null

getValue

java.lang.String getValue()
Returns the string description stored in this log entry

Returns:
String - The log entry
Throws:
PIMInternalException - If an internal error occurs

getDate

java.util.Date getDate()
Fetches the date and time at which this UserDefinedLogEntry was created or last updated.

Returns:
A Date object containing the date and time at which this entry was created or last updated.
Throws:
PIMInternalException - If an internal error occurs.

setDate

void setDate(java.util.Date date)
Sets the date for the UserDefinedLogEntry.

Throws:
PIMInternalException - If an internal error occurs.
PIMAuthorizationException - Reserved for future use
java.lang.IllegalArgumentException - If date is null

getTargetItem

Item getTargetItem()
Fetches the item to which this UserDefinedLogEntry is associated.

Returns:
An Item object.
Throws:
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.

getTargetCategory

Category getTargetCategory()
Fetches the category to which this UserDefinedLogEntry is associated.

Returns:
A Category object.
Throws:
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.