com.perforce.p4java.option.server
Class ExportRecordsOptions

java.lang.Object
  com.perforce.p4java.option.Options
      com.perforce.p4java.option.server.ExportRecordsOptions

public class ExportRecordsOptions
extends Options

Options class for IOptionsServer.getExportRecords method. Please see the relevant Perforce admin help for details of the meaning and usage of the options defined here -- this method is not intended for general use. Note also some special-casing in the options processing for this class.

Field Summary

protected String	filter
protected boolean	format
protected String	journalPrefix
protected long	maxRecs
protected long	offset
static String	OPTIONS_SPECS Dummy only.
protected int	sourceNum
protected boolean	useJournal

Fields inherited from class com.perforce.p4java.option.Options

immutable, optionList, OPTPFX

Constructor Summary

ExportRecordsOptions()
Default constructor; all fields set to false, null, or zero.

ExportRecordsOptions(boolean useJournal, long maxRecs, int sourceNum, long offset, boolean format, String journalPrefix, String filter)
Explicit-value constructor.

ExportRecordsOptions(String... options)
String options constructor; see Perforce admin documentation for help with these values.

Method Summary

String	getFilter()
String	getJournalPrefix()
long	getMaxRecs()
long	getOffset()
int	getSourceNum()
boolean	isFormat()
boolean	isUseJournal()
List<String>	processOptions(IServer server) Turn this (specific) options object into a list of strings to be sent to the Perforce server as options for a specific command.
ExportRecordsOptions	setFilter(String filter)
ExportRecordsOptions	setFormat(boolean format)
ExportRecordsOptions	setJournalPrefix(String journalPrefix)
ExportRecordsOptions	setMaxRecs(long maxRecs)
ExportRecordsOptions	setOffset(long offset)
ExportRecordsOptions	setSourceNum(int sourceNum)
ExportRecordsOptions	setUseJournal(boolean useJournal)

Methods inherited from class com.perforce.p4java.option.Options

applyRule, applyRule, applyRule, getOptions, isImmutable, processFields, setImmutable, setOptions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OPTIONS_SPECS

public static final String OPTIONS_SPECS

Dummy only. Do out use this string.

See Also:

Constant Field Values

useJournal

protected boolean useJournal

maxRecs

protected long maxRecs

sourceNum

protected int sourceNum

offset

protected long offset

format

protected boolean format

journalPrefix

protected String journalPrefix

filter

protected String filter

Constructor Detail

ExportRecordsOptions

public ExportRecordsOptions()

Default constructor; all fields set to false, null, or zero.

ExportRecordsOptions

public ExportRecordsOptions(String... options)

String options constructor; see Perforce admin documentation for help with these values.

ExportRecordsOptions

public ExportRecordsOptions(boolean useJournal,
                            long maxRecs,
                            int sourceNum,
                            long offset,
                            boolean format,
                            String journalPrefix,
                            String filter)

Explicit-value constructor.

Method Detail

processOptions

public List<String> processOptions(IServer server)
                            throws OptionsException

Description copied from class: Options

Turn this (specific) options object into a list of strings to be sent to the Perforce server as options for a specific command. As a side effect, set the option list associated with this Option to the result.

The method is used by the server object to generate the string-based arguments expected by the Perforce server corresponding to the state of this method-specific options object. Will return an empty list if there are no "interesting" options set or available. May simply return the superclass options string list if is non-null, but that behaviour is neither guaranteed nor required.

Note that this method is not intended to be called directly by users but by the underlying P4Java plumbing; odd results may occur if this method is called in other contexts.

Specified by:

processOptions in class Options

Parameters:

server - possibly-null IServer representing the Perforce server the options are to be used against. If this parameter is null, it is acceptable to throw an OptionsException, but it is also possible to ignore it and do the best you can with what you've got...

Returns:

non-null (but possibly empty) string list representing the normalized Perforce server arguments corresponding to the state of this specific options object.

Throws:

OptionsException - if an error occurs in options processing that is not some species of ConnectionException, RequestException, AccessException, etc.

See Also:

Options.processOptions(com.perforce.p4java.server.IServer)

isUseJournal

public boolean isUseJournal()

setUseJournal

public ExportRecordsOptions setUseJournal(boolean useJournal)

getMaxRecs

public long getMaxRecs()

setMaxRecs

public ExportRecordsOptions setMaxRecs(long maxRecs)

getSourceNum

public int getSourceNum()

setSourceNum

public ExportRecordsOptions setSourceNum(int sourceNum)

getOffset

public long getOffset()

setOffset

public ExportRecordsOptions setOffset(long offset)

isFormat

public boolean isFormat()

setFormat

public ExportRecordsOptions setFormat(boolean format)

getJournalPrefix

public String getJournalPrefix()

setJournalPrefix

public ExportRecordsOptions setJournalPrefix(String journalPrefix)

getFilter

public String getFilter()

setFilter

public ExportRecordsOptions setFilter(String filter)