Package com.perforce.p4java.server.delegator

Interface IPropertyDelegator

All Known Subinterfaces:

IOptionsServer, IServer, IStreamingServer

All Known Implementing Classes:

NtsServerImpl, OneShotServerImpl, PropertyDelegator, RpcServer, Server

public interface IPropertyDelegator

Interface to handle the Property command.

Method Summary

Modifier and Type	Method	Description
java.lang.String	deleteProperty(java.lang.String name, PropertyOptions opts)	Deletes a property value from the Perforce server.
java.util.List<IProperty>	getProperty(GetPropertyOptions opts)	Gets a list of one or more property values from the Perforce server.
java.lang.String	setProperty(java.lang.String name, java.lang.String value, PropertyOptions opts)	Updates a property value in the Perforce server, or adds the property value to the Perforce server if it is not yet there.

Method Detail

setProperty

java.lang.String setProperty(java.lang.String name,
                             java.lang.String value,
                             PropertyOptions opts)
                      throws P4JavaException

Updates a property value in the Perforce server, or adds the property value to the Perforce server if it is not yet there.

This method require that the user have 'admin' access granted by 'p4 protect'.

Parameters:

name - non-null property name.

value - property value.

opts - PropertyOptions object describing optional parameters; if null, no options are set.

Returns:

non-null result message string from the set (add/update) operation.

Throws:

P4JavaException - if an error occurs processing this method and its parameters.

Since:

2013.1

getProperty

java.util.List<IProperty> getProperty(GetPropertyOptions opts)
                               throws P4JavaException

Gets a list of one or more property values from the Perforce server.

The -A flag require that the user have 'admin' access granted by 'p4 protect'.

Note that specifying the -n flag when using the -l flag substantially improves the performance of this command.

Parameters:

opts - GetPropertyOptions object describing optional parameters; if null, no options are set.

Returns:

a non-null (but possibly empty) list of property values.

Throws:

P4JavaException - if an error occurs processing this method and its parameters.

Since:

2013.1

deleteProperty

java.lang.String deleteProperty(java.lang.String name,
                                PropertyOptions opts)
                         throws P4JavaException

Deletes a property value from the Perforce server.

This method require that the user have 'admin' access granted by 'p4 protect'.

Parameters:

name - non-null property name.

opts - PropertyOptions object describing optional parameters; if null, no options are set.

Returns:

non-null result message string from the delete operation.

Throws:

P4JavaException - if an error occurs processing this method and its parameters.

Since:

2013.1