Package com.perforce.p4java.server.delegator

Interface ITriggersDelegator

All Known Subinterfaces:

IOptionsServer, IServer, IStreamingServer

All Known Implementing Classes:

NtsServerImpl, OneShotServerImpl, RpcServer, Server, TriggersDelegator

public interface ITriggersDelegator

Interface to handle the Triggers command.

Method Summary

Modifier and Type	Method	Description
java.lang.String	createTriggerEntries(java.util.List<ITriggerEntry> entryList)	Create or replace the triggers table data on the Perforce server with these new trigger entries.
java.util.List<ITriggerEntry>	getTriggerEntries()	Get a list of Perforce trigger entries.
java.io.InputStream	getTriggersTable()	Get an InputStream onto the entries of the Perforce triggers table.
java.lang.String	updateTriggerEntries(java.util.List<ITriggerEntry> entryList)	Replace the triggers table data on the Perforce server with these new triggers entries.

Method Detail

createTriggerEntries

java.lang.String createTriggerEntries(@Nonnull
                                      java.util.List<ITriggerEntry> entryList)
                               throws P4JavaException

Create or replace the triggers table data on the Perforce server with these new trigger entries.

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

Warning: this will overwrite the existing triggers table data.

Parameters:

entryList - non-null list of trigger entries.

Returns:

possibly-null status message string as returned from the server

Throws:

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

Since:

2014.1

getTriggerEntries

java.util.List<ITriggerEntry> getTriggerEntries()
                                         throws P4JavaException

Get a list of Perforce trigger entries.

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

Returns:

non-null but possibly empty list of trigger entries.

Throws:

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

Since:

2014.1

updateTriggerEntries

java.lang.String updateTriggerEntries(@Nonnull
                                      java.util.List<ITriggerEntry> entryList)
                               throws P4JavaException

Replace the triggers table data on the Perforce server with these new triggers entries.

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

Warning: this will overwrite the existing triggers table data.

Parameters:

entryList - non-null list of trigger entries.

Returns:

possibly-null status message string as returned from the server

Throws:

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

Since:

2014.1

getTriggersTable

java.io.InputStream getTriggersTable()
                              throws P4JavaException

Get an InputStream onto the entries of the Perforce triggers table.

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

Returns:

a non-null but possibly empty InputStream onto the triggers table's entries.

Throws:

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

Since:

2014.1