com.ibm.pim.spec
Interface FileSpec

All Superinterfaces:
Spec

public interface FileSpec
extends Spec

Interface for the File Spec object

Since:
6.0.0

Nested Class Summary
static class FileSpec.FileType
          File types
 
Nested classes/interfaces inherited from interface com.ibm.pim.spec.Spec
Spec.Type
 
Field Summary
static java.lang.String copyright
           
 
Method Summary
 FileSpec.FileType getFileType()
          Get the fileType associated to this File Spec
 void setDelimiter(java.lang.String delimiter)
          Set the delimiter character for FileSpec of type DELIMITED
 void setIgnoreHeaderLineCount(int ignoreHeaderLines)
          Set the number of header lines to ignore
 
Methods inherited from interface com.ibm.pim.spec.Spec
addLocale, createAttributeDefinition, delete, getAttributeDefinition, getAttributeDefinitions, getLocales, getName, getRootAttributeDefinition, getType, isLocalized, removeAttributeDefinition, removeLocale, replaceLocales, save, setLocalized
 

Field Detail

copyright

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

setDelimiter

void setDelimiter(java.lang.String delimiter)
Set the delimiter character for FileSpec of type DELIMITED

Parameters:
delimiter - Delimiter character for the spec

setIgnoreHeaderLineCount

void setIgnoreHeaderLineCount(int ignoreHeaderLines)
Set the number of header lines to ignore

Parameters:
ignoreHeaderLines - Number of header lines to ignore

getFileType

FileSpec.FileType getFileType()
Get the fileType associated to this File Spec

Returns:
FileType Type of the file
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use