com.ibm.pim.system
Interface PIMWriter


public interface PIMWriter

Interface for the PIMWriter object.

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 java.lang.String getName()
          Returns the name of the writer.
 java.util.Map<java.lang.String,java.lang.String> getProperties()
          Returns the properties of the writer.
 java.io.Writer getWriter()
          Returns an instance of java.io.Writer.
 void setName(java.lang.String name)
          Sets the name of the writer.
 void setProperty(java.lang.String propertyName, java.lang.String propertyValue)
          Sets the property of the writer.
 

Field Detail

copyright

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

getProperties

java.util.Map<java.lang.String,java.lang.String> getProperties()
Returns the properties of the writer.

Returns:
properties of the writer.
Throws:
PIMInternalException - If an internal exception occurs.

setProperty

void setProperty(java.lang.String propertyName,
                 java.lang.String propertyValue)
Sets the property of the writer.

Parameters:
propertyName - Name of the property.
propertyValue - Value of the property.
Throws:
PIMInternalException - If an internal exception occurs.
PIMAuthorizationException - Reserved for future use
java.lang.IllegalArgumentException - If the arguments are null or an empty string

getName

java.lang.String getName()
Returns the name of the writer.

Returns:
name of the writer.
Throws:
PIMInternalException - If an internal exception occurs.

setName

void setName(java.lang.String name)
Sets the name of the writer.

Parameters:
name - name of the writer.
Throws:
PIMInternalException - If an internal exception occurs.
PIMAuthorizationException - Reserved for future use
java.lang.IllegalArgumentException - If the name is null or an empty string

getWriter

java.io.Writer getWriter()
Returns an instance of java.io.Writer.

Returns:
java.io.Writer object.
Throws:
PIMInternalException - If an internal exception occurs.