JobSpec (P4Java API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.perforce.p4java.impl.generic.core
Class JobSpec

java.lang.Object
  com.perforce.p4java.impl.generic.core.ServerResource
      com.perforce.p4java.impl.generic.core.JobSpec

Simple generic default implementation class for the IJobSpec interface.

Nested Class Summary
`protected class`	`JobSpec.JobSpecField`

Nested classes/interfaces inherited from interface com.perforce.p4java.core.IJobSpec
`IJobSpec.IJobSpecField`

Field Summary

Fields inherited from class com.perforce.p4java.impl.generic.core.ServerResource
`refreshable, server, updateable`

Constructor Summary
`JobSpec()`
`JobSpec(java.util.Map<java.lang.String,java.lang.Object> map, IServer server)`

Method Summary
`void`	`complete()` Completing a job spec calls `refresh()` and updates the `#isComplete()` flag.
`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.

Methods inherited from class com.perforce.p4java.impl.generic.core.ServerResource
`canRefresh, canUpdate, setRefreshable, setServer, update`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.perforce.p4java.core.IServerResource
`canRefresh, canUpdate, setServer, update`

Constructor Detail

public JobSpec()

public JobSpec(java.util.Map<java.lang.String,java.lang.Object> map,
               IServer server)

Method Detail

public void complete()
              throws ConnectionException,
                     RequestException,
                     AccessException

Completing a job spec calls refresh() and updates the #isComplete() flag.

public void refresh()
             throws ConnectionException,
                    RequestException,
                    AccessException

This method will refresh by getting the complete job spec model. If this refresh is successful then this job spec will be marked as complete.

Throws:: ConnectionException - if the Perforce server is unreachable or is not connected.; RequestException - if the Perforce server encounters an error during its processing of the request; AccessException - if the Perforce server denies access to the caller
See Also:: ServerResource.refresh()