public class JobSpec extends ServerResource implements IJobSpec
Modifier and Type | Class and Description |
---|---|
protected class |
JobSpec.JobSpecField |
IJobSpec.IJobSpecField
refreshable, server, updateable
Constructor and Description |
---|
JobSpec() |
JobSpec(java.util.Map<java.lang.String,java.lang.Object> map,
IServer server) |
Modifier and Type | Method and Description |
---|---|
void |
complete()
Completing a job spec calls
refresh() |
java.lang.String |
getComments()
Get the comments associated with this jobspec.
|
java.lang.String |
getFieldPreset(java.lang.String fieldName)
Get the preset for a given field.
|
java.util.List<IJobSpec.IJobSpecField> |
getFields()
Return a list of all known Perforce job fields on this jobspec.
|
java.util.List<java.lang.String> |
getFieldValues(java.lang.String fieldName)
Get a list of field values for a given field.
|
java.util.Map<java.lang.String,java.lang.String> |
getPresets()
Return a map of the possible presets for each known jobspec field.
|
java.util.Map<java.lang.String,java.util.List<java.lang.String>> |
getValues()
Return a map of the values 'select' fields can have for each relevant jobspec
field.
|
void |
refresh()
This method will refresh by getting the complete job spec model.
|
void |
setComments(java.lang.String comments)
Set the comments associated with this jobspec.
|
void |
setFields(java.util.List<IJobSpec.IJobSpecField> fields)
Set the list of all known Perforce job fields on this jobspec.
|
void |
setPresets(java.util.Map<java.lang.String,java.lang.String> presets)
Set the map of the possible presets for each known jobspec field.
|
void |
setValues(java.util.Map<java.lang.String,java.util.List<java.lang.String>> values)
Set the map of the values 'select' fields can have for each relevant jobspec
field.
|
canRefresh, canUpdate, clearRawFields, getRawField, getRawFields, hasRawField, parseDate, setRawField, setRawFields, setRefreshable, setServer, toDateString, update, update, update
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
canRefresh, canUpdate, clearRawFields, getRawField, getRawFields, hasRawField, setRawField, setRawFields, setServer, update, update, update
public JobSpec()
public JobSpec(java.util.Map<java.lang.String,java.lang.Object> map, IServer server)
public void complete() throws ConnectionException, RequestException, AccessException
refresh()
complete
in interface IServerResource
complete
in class ServerResource
ConnectionException
- when there is an error talking to the Helix serverRequestException
- when there is a problem with the data provided in the requestAccessException
- when access to the branch command is not authorisedrefresh()
,
ServerResource.complete()
public void refresh() throws ConnectionException, RequestException, AccessException
refresh
in interface IServerResource
refresh
in class ServerResource
ConnectionException
- if the Perforce server is unreachable or is not
connected.RequestException
- if the Perforce server encounters an error during
its processing of the requestAccessException
- if the Perforce server denies access to the callerServerResource.refresh()
public java.lang.String getComments()
IJobSpec
getComments
in interface IJobSpec
IJobSpec.getComments()
public java.util.List<IJobSpec.IJobSpecField> getFields()
IJobSpec
getFields
in interface IJobSpec
IJobSpec.getFields()
public java.util.Map<java.lang.String,java.lang.String> getPresets()
IJobSpec
getPresets
in interface IJobSpec
IJobSpec.getPresets()
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getValues()
IJobSpec
getValues
in interface IJobSpec
IJobSpec.getValues()
public java.util.List<java.lang.String> getFieldValues(java.lang.String fieldName)
IJobSpec
getFieldValues
in interface IJobSpec
fieldName
- non-null field nameIJobSpec.getFieldValues(java.lang.String)
public java.lang.String getFieldPreset(java.lang.String fieldName)
IJobSpec
getFieldPreset
in interface IJobSpec
fieldName
- non-null field nameIJobSpec.getFieldPreset(java.lang.String)
public void setComments(java.lang.String comments)
IJobSpec
setComments
in interface IJobSpec
comments
- jobspec comment stringIJobSpec.setComments(java.lang.String)
public void setFields(java.util.List<IJobSpec.IJobSpecField> fields)
IJobSpec
setFields
in interface IJobSpec
fields
- list of job fieldsIJobSpec.setFields(java.util.List)
public void setPresets(java.util.Map<java.lang.String,java.lang.String> presets)
IJobSpec
setPresets
in interface IJobSpec
presets
- map of presetsIJobSpec.setPresets(java.util.Map)
public void setValues(java.util.Map<java.lang.String,java.util.List<java.lang.String>> values)
IJobSpec
setValues
in interface IJobSpec
values
- value mapIJobSpec.setValues(java.util.Map)