com.perforce.p4java.impl.mapbased.server.cmd

Class SpecDelegator

java.lang.Object

com.perforce.p4java.impl.mapbased.server.cmd.BaseDelegator

com.perforce.p4java.impl.mapbased.server.cmd.SpecDelegator

All Implemented Interfaces:

ISpecDelegator

public class SpecDelegator
extends BaseDelegator
implements ISpecDelegator

Field Summary

Fields inherited from class com.perforce.p4java.impl.mapbased.server.cmd.BaseDelegator

MAX_LIMIT_SUPPORTED_MIN_VERSION, QUERY_EXPRESSIONS_SUPPORTED_MIN_VERSION, USER_RESTRICTIONS_SUPPORTED_MIN_VERSION

Constructor Summary

Constructors

Constructor and Description
SpecDelegator(IOptionsServer server) Instantiates a new job spec delegator.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getSpec(CustomSpec type) Return the Perforce spec associated with this Perforce server.
java.lang.String	updateSpec(CustomSpec type, java.util.Map<java.lang.String,java.lang.Object> spec) Update a Perforce spec on the Perforce server.
java.lang.String	updateSpecString(CustomSpec type, java.lang.String spec) Update a Perforce spec on the Perforce server.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpecDelegator

public SpecDelegator(IOptionsServer server)

Instantiates a new job spec delegator.

Parameters:

server - the server

Method Detail

getSpec

public java.util.Map<java.lang.String,java.lang.Object> getSpec(CustomSpec type)
                                                         throws AccessException,
                                                                RequestException,
                                                                ConnectionException

Description copied from interface: ISpecDelegator

Return the Perforce spec associated with this Perforce server.

Specified by:

getSpec in interface ISpecDelegator

Parameters:

type - spec type, ('job' or 'stream') to be updated.

Returns:

possibly-null map representing the underlying Perforce server's spec.

Throws:

AccessException

RequestException

ConnectionException

updateSpec

public java.lang.String updateSpec(CustomSpec type,
                                   java.util.Map<java.lang.String,java.lang.Object> spec)
                            throws P4JavaException

Description copied from interface: ISpecDelegator

Update a Perforce spec on the Perforce server.

Specified by:

updateSpec in interface ISpecDelegator

Parameters:

type - spec type, ('job' or 'stream') to be updated.

spec - updated spec as a map.

Returns:

non-null result message string from the Perforce server; this may include form trigger output pre-pended and / or appended to the "normal" message.

Throws:

P4JavaException - if any error occurs in the processing of this method.

updateSpecString

public java.lang.String updateSpecString(CustomSpec type,
                                         java.lang.String spec)
                                  throws P4JavaException

Description copied from interface: ISpecDelegator

Update a Perforce spec on the Perforce server.

Specified by:

updateSpecString in interface ISpecDelegator

Parameters:

type - spec type, ('job' or 'stream') to be updated.

spec - updated spec as a map.

Returns:

non-null result message string from the Perforce server; this may include form trigger output pre-pended and / or appended to the "normal" message.

Throws:

P4JavaException - if any error occurs in the processing of this method.