Skip to main content

%pkg.isc.changecontrol.rest.api.UncommittedQueueBase

abstract class %pkg.isc.changecontrol.rest.api.UncommittedQueueBase extends %pkg.isc.rest.model.proxy

REST API class for managing the Uncommitted Queue independent of change control application. Contains methods that handle undo checkout, retrieving file contents, and information about an Uncommitted Queue entry. NOTE: For subclasses, the session key for the request can be obtained using the following: set changeclass = ##class(%XML.Exchange.ChangeControlInterface).ChangeControlClassGet() set sessionKey = $CLASSMETHOD(changeclass, "GetSessionKey") @API.Extensible

Method Inventory

Parameters

final parameter MEDIATYPE = application/vnd.intersystems.com.changecontrol.crud.v1+json;
Inherited description: Content-Type implemented in this class Subclasses MAY override this
parameter RESOURCENAME = uncommitted-queue-base;
@API.Overridable
final parameter SOURCECLASS = %pkg.isc.changecontrol.rest.UncommittedQueueModel;
Inherited description: The class to which this class provides REST access. It must extend %Persistent and have its %JSONENABLED class parameter set to 1 (e.g., by extending %JSON.Adaptor). Subclasses must override this parameter.

Methods

abstract classmethod RestChangeSessionInfo(payload As %pkg.isc.changecontrol.rest.InputModelBase) as %pkg.isc.changecontrol.rest.ResponseModelBase
Retrieves info for the change session from the change control server.
MUST be overridden in subclasses.
@API.Overrideable
Commit changes to change control server. MUST be implemented in subclass. @API.Overridable
final classmethod RestFilterParams() as %pkg.isc.changecontrol.rest.FilterParamsResponse
Returns paramters to filter by.
final classmethod RestUndoCheckout(revertArgs As %pkg.isc.changecontrol.rest.RevertInput) as %pkg.isc.changecontrol.rest.RevertOutput
Reverts provided changes and deletes all items' .bak
final classmethod RestView(pId As %String) as %pkg.isc.changecontrol.rest.XMLContentResponse
Retrieves contents of exported XML file and .bak for view/diff

Inherited Members

Inherited Methods

FeedbackOpens in a new tab